Package software.amazon.awssdk.services.directconnect.model

Class DirectConnectGatewayAttachment

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

Information about an attachment between a Direct Connect gateway and a virtual interface.

See Also:

  • Method Details

    • directConnectGatewayId

      public final String directConnectGatewayId()

      The ID of the Direct Connect gateway.

      Returns:
      The ID of the Direct Connect gateway.

    • virtualInterfaceId

      public final String virtualInterfaceId()

      The ID of the virtual interface.

      Returns:
      The ID of the virtual interface.

    • virtualInterfaceRegion

      public final String virtualInterfaceRegion()

      The Amazon Web Services Region where the virtual interface is located.

      Returns:
      The Amazon Web Services Region where the virtual interface is located.

    • virtualInterfaceOwnerAccount

      public final String virtualInterfaceOwnerAccount()

      The ID of the Amazon Web Services account that owns the virtual interface.

      Returns:
      The ID of the Amazon Web Services account that owns the virtual interface.

    • attachmentState

      public final DirectConnectGatewayAttachmentState attachmentState()

      The state of the attachment. The following are the possible values:

      • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.

      • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

      • detaching: The initial state after calling DeleteVirtualInterface.

      • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

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

      Returns:
      The state of the attachment. The following are the possible values:

      • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.

      • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

      • detaching: The initial state after calling DeleteVirtualInterface.

      • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

      See Also:

    • attachmentStateAsString

      public final String attachmentStateAsString()

      The state of the attachment. The following are the possible values:

      • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.

      • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

      • detaching: The initial state after calling DeleteVirtualInterface.

      • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

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

      Returns:
      The state of the attachment. The following are the possible values:

      • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.

      • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

      • detaching: The initial state after calling DeleteVirtualInterface.

      • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

      See Also:

    • attachmentType

      public final DirectConnectGatewayAttachmentType attachmentType()

      The type of attachment.

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

      Returns:
      The type of attachment.
      See Also:

    • attachmentTypeAsString

      public final String attachmentTypeAsString()

      The type of attachment.

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

      Returns:
      The type of attachment.
      See Also:

    • stateChangeError

      public final String stateChangeError()

      The error message if the state of an object failed to advance.

      Returns:
      The error message if the state of an object failed to advance.

    • toBuilder

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

    • builder

      public static DirectConnectGatewayAttachment.Builder builder()

    • serializableBuilderClass

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