Class NewPublicVirtualInterfaceAllocation

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

Information about a public virtual interface to be provisioned on a connection.

See Also:

  • Method Details

    • virtualInterfaceName

      public final String virtualInterfaceName()

      The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

      Returns:
      The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

    • vlan

      public final Integer vlan()

      The ID of the VLAN.

      Returns:
      The ID of the VLAN.

    • asn

      public final Integer asn()

      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      The valid values are 1-2147483647.

      Returns:
      The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      The valid values are 1-2147483647.

    • authKey

      public final String authKey()

      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

      Returns:
      The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

    • amazonAddress

      public final String amazonAddress()

      The IP address assigned to the Amazon interface.

      Returns:
      The IP address assigned to the Amazon interface.

    • customerAddress

      public final String customerAddress()

      The IP address assigned to the customer interface.

      Returns:
      The IP address assigned to the customer interface.

    • addressFamily

      public final AddressFamily addressFamily()

      The address family for the BGP peer.

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

      Returns:
      The address family for the BGP peer.
      See Also:

    • addressFamilyAsString

      public final String addressFamilyAsString()

      The address family for the BGP peer.

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

      Returns:
      The address family for the BGP peer.
      See Also:

    • hasRouteFilterPrefixes

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

    • routeFilterPrefixes

      public final List<RouteFilterPrefix> routeFilterPrefixes()

      The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

      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 hasRouteFilterPrefixes() method.

      Returns:
      The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The tags associated with the public virtual 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 hasTags() method.

      Returns:
      The tags associated with the public virtual interface.

    • toBuilder

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

    • builder

      public static NewPublicVirtualInterfaceAllocation.Builder builder()

    • serializableBuilderClass

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