Class MsftNetAdapterToIpAndDnsAndProfile

java.lang.Object

io.github.eggy03.ferrumx.windows.entity.compounded.MsftNetAdapterToIpAndDnsAndProfile

@ShallowImmutable
public class MsftNetAdapterToIpAndDnsAndProfile
extends Object

Immutable representation of a MsftNetAdapter and its 1:N relationships with MsftNetIpAddress, MsftDnsClientServerAddress, and MsftNetConnectionProfile configurations in a Windows system.

Each instance represents a single NetAdapter identified by interfaceIndex, and maintains a one-to-many mapping with related IpAddress, DnsClientServerAddress, and ConnectionProfile entities.

Usage example

MsftNetAdapterToIpAndDnsAndProfile adapterInfo = MsftNetAdapterToIpAndDnsAndProfile.builder()
    .interfaceIndex(12L)
    .adapter(msftNetAdapter)
    .ipAddressList(ipAddresses)
    .dnsClientServerAddressList(dnsServers)
    .netConnectionProfileList(connectionProfiles)
    .build();

This is purely a convenience class designed to simplify data retrieval for all related network configuration entities through a single call. The individual entity classes remain accessible for direct use if you need to map everything by yourself.

An equivalent convenience class Win32NetworkAdapterToConfiguration is also available for use, although Win32_NetworkAdapter is deprecated by Microsoft in favor of the MSFT classes.

Since:

3.0.0

See Also:

• MsftNetAdapter
• MsftNetIpAddress
• MsftDnsClientServerAddress
• MsftNetConnectionProfile

Field Summary

Fields

Modifier and Type	Field	Description
(package private) @Nullable MsftNetAdapter	adapter	The MsftNetAdapter associated with the index: interfaceIndex
(package private) @Nullable List<MsftDnsClientServerAddress>	dnsClientServerAddressList	A list of MsftDnsClientServerAddress associated with the index: interfaceIndex
(package private) @Nullable Long	interfaceIndex	The unique index identifying the MsftNetAdapter instance
(package private) @Nullable List<MsftNetIpAddress>	ipAddressList	A list of MsftNetIpAddress associated with the index: interfaceIndex
(package private) @Nullable List<MsftNetConnectionProfile>	netConnectionProfileList	A list of MsftNetConnectionProfile associated with the index: interfaceIndex

Constructor Summary

Constructors

Constructor	Description
MsftNetAdapterToIpAndDnsAndProfile()

Method Summary

Modifier and Type	Method	Description
@NotNull String	toString()	Retrieves the entity in a JSON pretty-print formatted string

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

interfaceIndex

@SerializedName("InterfaceIndex")
@Nullable
@Nullable Long interfaceIndex

The unique index identifying the MsftNetAdapter instance

adapter

@SerializedName("NetworkAdapter")
@Nullable
@Nullable MsftNetAdapter adapter

The MsftNetAdapter associated with the index: interfaceIndex

ipAddressList

@SerializedName("IPAddresses")
@Nullable
@Nullable List<MsftNetIpAddress> ipAddressList

A list of MsftNetIpAddress associated with the index: interfaceIndex

dnsClientServerAddressList

@SerializedName("DNSServers")
@Nullable
@Nullable List<MsftDnsClientServerAddress> dnsClientServerAddressList

A list of MsftDnsClientServerAddress associated with the index: interfaceIndex

netConnectionProfileList

@SerializedName("Profile")
@Nullable
@Nullable List<MsftNetConnectionProfile> netConnectionProfileList

A list of MsftNetConnectionProfile associated with the index: interfaceIndex

Constructor Details

MsftNetAdapterToIpAndDnsAndProfile

public MsftNetAdapterToIpAndDnsAndProfile()

Method Details

toString

@NotNull
public @NotNull String toString()

Retrieves the entity in a JSON pretty-print formatted string

Overrides:

toString in class Object

Returns:

the String value of the object in JSON pretty-print format