Class ConnectionSummary

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

Summarized view of a Connection object.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the requested Connection

      Returns:
      The identifier of the requested Connection

    • arn

      public final String arn()

      The ARN of the Connection

      Returns:
      The ARN of the Connection

    • description

      public final String description()

      A descriptive name of the Connection

      Returns:
      A descriptive name of the Connection

    • bandwidth

      public final String bandwidth()

      The bandwidth of the Connection

      Returns:
      The bandwidth of the Connection

    • attachPoint

      public final AttachPoint attachPoint()

      The Attach Point to which the connection should be associated.

      Returns:
      The Attach Point to which the connection should be associated.

    • environmentId

      public final String environmentId()

      The Environment that this Connection is created on.

      Returns:
      The Environment that this Connection is created on.

    • provider

      public final Provider provider()

      The provider on the remote end of this Connection

      Returns:
      The provider on the remote end of this Connection

    • location

      public final String location()

      The provider specific location at the remote end of this Connection

      Returns:
      The provider specific location at the remote end of this Connection

    • type

      public final String type()

      The product variant supplied by this resource.

      Returns:
      The product variant supplied by this resource.

    • state

      public final ConnectionState state()

      • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

      • pending: The connection has been accepted and is being provisioned between AWS and the Partner.

      • available: The connection has been fully provisioned between AWS and the Partner.

      • deleting: The connection is being deleted.

      • deleted: The connection has been deleted.

      • failed: The connection has failed to be created.

      • updating: The connection is being updated.

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

      Returns:

    • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

    • pending: The connection has been accepted and is being provisioned between AWS and the Partner.

    • available: The connection has been fully provisioned between AWS and the Partner.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • failed: The connection has failed to be created.

    • updating: The connection is being updated.

      • See Also:

    • stateAsString

      public final String stateAsString()

      • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

      • pending: The connection has been accepted and is being provisioned between AWS and the Partner.

      • available: The connection has been fully provisioned between AWS and the Partner.

      • deleting: The connection is being deleted.

      • deleted: The connection has been deleted.

      • failed: The connection has failed to be created.

      • updating: The connection is being updated.

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

      Returns:

    • requested: The initial state of a connection. The state will remain here until the Connection is accepted on the Partner portal.

    • pending: The connection has been accepted and is being provisioned between AWS and the Partner.

    • available: The connection has been fully provisioned between AWS and the Partner.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • failed: The connection has failed to be created.

    • updating: The connection is being updated.

      • See Also:

    • sharedId

      public final String sharedId()

      An identifier used by both AWS and the remote partner to identify the specific connection.

      Returns:
      An identifier used by both AWS and the remote partner to identify the specific connection.

    • billingTier

      public final Integer billingTier()

      The billing tier this connection is currently assigned.

      Returns:
      The billing tier this connection is currently assigned.

    • toBuilder

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

    • builder

      public static ConnectionSummary.Builder builder()

    • serializableBuilderClass

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