Class NetworkInterface

java.lang.Object
software.amazon.awssdk.services.inspector.model.NetworkInterface
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NetworkInterface.Builder,NetworkInterface>

@Generated("software.amazon.awssdk:codegen") public final class NetworkInterface extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NetworkInterface.Builder,NetworkInterface>

Contains information about the network interfaces interacting with an EC2 instance. This data type is used as one of the elements of the AssetAttributes data type.

See Also:
  • Method Details

    • networkInterfaceId

      public final String networkInterfaceId()

      The ID of the network interface.

      Returns:
      The ID of the network interface.
    • subnetId

      public final String subnetId()

      The ID of a subnet associated with the network interface.

      Returns:
      The ID of a subnet associated with the network interface.
    • vpcId

      public final String vpcId()

      The ID of a VPC associated with the network interface.

      Returns:
      The ID of a VPC associated with the network interface.
    • privateDnsName

      public final String privateDnsName()

      The name of a private DNS associated with the network interface.

      Returns:
      The name of a private DNS associated with the network interface.
    • privateIpAddress

      public final String privateIpAddress()

      The private IP address associated with the network interface.

      Returns:
      The private IP address associated with the network interface.
    • hasPrivateIpAddresses

      public final boolean hasPrivateIpAddresses()
      For responses, this returns true if the service returned a value for the PrivateIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • privateIpAddresses

      public final List<PrivateIp> privateIpAddresses()

      A list of the private IP addresses associated with the network interface. Includes the privateDnsName and privateIpAddress.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrivateIpAddresses() method.

      Returns:
      A list of the private IP addresses associated with the network interface. Includes the privateDnsName and privateIpAddress.
    • publicDnsName

      public final String publicDnsName()

      The name of a public DNS associated with the network interface.

      Returns:
      The name of a public DNS associated with the network interface.
    • publicIp

      public final String publicIp()

      The public IP address from which the network interface is reachable.

      Returns:
      The public IP address from which the network interface is reachable.
    • hasIpv6Addresses

      public final boolean hasIpv6Addresses()
      For responses, this returns true if the service returned a value for the Ipv6Addresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • ipv6Addresses

      public final List<String> ipv6Addresses()

      The IP addresses associated with the network interface.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpv6Addresses() method.

      Returns:
      The IP addresses associated with the network interface.
    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • securityGroups

      public final List<SecurityGroup> securityGroups()

      A list of the security groups associated with the network interface. Includes the groupId and groupName.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.

      Returns:
      A list of the security groups associated with the network interface. Includes the groupId and groupName.
    • toBuilder

      public NetworkInterface.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NetworkInterface.Builder,NetworkInterface>
      Returns:
      a builder for type T
    • builder

      public static NetworkInterface.Builder builder()
    • serializableBuilderClass

      public static Class<? extends NetworkInterface.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.