Class InstanceNetworkInterfaceSpecification

java.lang.Object
software.amazon.awssdk.services.workspacesinstances.model.InstanceNetworkInterfaceSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>
@Generated("software.amazon.awssdk:codegen") public final class InstanceNetworkInterfaceSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>

Defines network interface configuration for WorkSpace Instance.

See Also:

  • Method Details

    • associateCarrierIpAddress

      public final Boolean associateCarrierIpAddress()

      Enables carrier IP address association.

      Returns:
      Enables carrier IP address association.

    • associatePublicIpAddress

      public final Boolean associatePublicIpAddress()

      Enables public IP address assignment.

      Returns:
      Enables public IP address assignment.

    • connectionTrackingSpecification

      public final ConnectionTrackingSpecificationRequest connectionTrackingSpecification()

      Configures network connection tracking parameters.

      Returns:
      Configures network connection tracking parameters.

    • description

      public final String description()

      Descriptive text for the network interface.

      Returns:
      Descriptive text for the network interface.

    • deviceIndex

      public final Integer deviceIndex()

      Unique index for the network interface.

      Returns:
      Unique index for the network interface.

    • enaSrdSpecification

      public final EnaSrdSpecificationRequest enaSrdSpecification()

      Configures Elastic Network Adapter Scalable Reliable Datagram settings.

      Returns:
      Configures Elastic Network Adapter Scalable Reliable Datagram settings.

    • interfaceType

      public final InterfaceTypeEnum interfaceType()

      Specifies the type of network interface.

      If the service returns an enum value that is not available in the current SDK version, interfaceType will return InterfaceTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interfaceTypeAsString().

      Returns:
      Specifies the type of network interface.
      See Also:

    • interfaceTypeAsString

      public final String interfaceTypeAsString()

      Specifies the type of network interface.

      If the service returns an enum value that is not available in the current SDK version, interfaceType will return InterfaceTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interfaceTypeAsString().

      Returns:
      Specifies the type of network interface.
      See Also:

    • hasIpv4Prefixes

      public final boolean hasIpv4Prefixes()
      For responses, this returns true if the service returned a value for the Ipv4Prefixes 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.

    • ipv4Prefixes

      public final List<Ipv4PrefixSpecificationRequest> ipv4Prefixes()

      IPv4 prefix configurations for the 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 hasIpv4Prefixes() method.

      Returns:
      IPv4 prefix configurations for the interface.

    • ipv4PrefixCount

      public final Integer ipv4PrefixCount()

      Number of IPv4 prefixes to assign.

      Returns:
      Number of IPv4 prefixes to assign.

    • ipv6AddressCount

      public final Integer ipv6AddressCount()

      Number of IPv6 addresses to assign.

      Returns:
      Number of IPv6 addresses to assign.

    • 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<InstanceIpv6Address> ipv6Addresses()

      Specific IPv6 addresses for the 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:
      Specific IPv6 addresses for the interface.

    • hasIpv6Prefixes

      public final boolean hasIpv6Prefixes()
      For responses, this returns true if the service returned a value for the Ipv6Prefixes 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.

    • ipv6Prefixes

      public final List<Ipv6PrefixSpecificationRequest> ipv6Prefixes()

      IPv6 prefix configurations for the 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 hasIpv6Prefixes() method.

      Returns:
      IPv6 prefix configurations for the interface.

    • ipv6PrefixCount

      public final Integer ipv6PrefixCount()

      Number of IPv6 prefixes to assign.

      Returns:
      Number of IPv6 prefixes to assign.

    • networkCardIndex

      public final Integer networkCardIndex()

      Index of the network card for multiple network interfaces.

      Returns:
      Index of the network card for multiple network interfaces.

    • networkInterfaceId

      public final String networkInterfaceId()

      Unique identifier for the network interface.

      Returns:
      Unique identifier for the network interface.

    • primaryIpv6

      public final Boolean primaryIpv6()

      Indicates the primary IPv6 configuration.

      Returns:
      Indicates the primary IPv6 configuration.

    • privateIpAddress

      public final String privateIpAddress()

      Primary private IP address for the interface.

      Returns:
      Primary private IP address for the 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<PrivateIpAddressSpecification> privateIpAddresses()

      List of private IP addresses for the 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 hasPrivateIpAddresses() method.

      Returns:
      List of private IP addresses for the interface.

    • secondaryPrivateIpAddressCount

      public final Integer secondaryPrivateIpAddressCount()

      Number of additional private IP addresses to assign.

      Returns:
      Number of additional private IP addresses to assign.

    • hasGroups

      public final boolean hasGroups()
      For responses, this returns true if the service returned a value for the Groups 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.

    • groups

      public final List<String> groups()

      Security groups 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 hasGroups() method.

      Returns:
      Security groups associated with the network interface.

    • subnetId

      public final String subnetId()

      Subnet identifier for the network interface.

      Returns:
      Subnet identifier for the network interface.

    • toBuilder

      public InstanceNetworkInterfaceSpecification.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<InstanceNetworkInterfaceSpecification.Builder,InstanceNetworkInterfaceSpecification>
      Returns:
      a builder for type T

    • builder

      public static InstanceNetworkInterfaceSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceNetworkInterfaceSpecification.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.