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

Class CreateInterconnectResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.directconnect.model.DirectConnectResponse
software.amazon.awssdk.services.directconnect.model.CreateInterconnectResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateInterconnectResponse.Builder,CreateInterconnectResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateInterconnectResponse extends DirectConnectResponse implements ToCopyableBuilder<CreateInterconnectResponse.Builder,CreateInterconnectResponse>

Information about an interconnect.

  • Method Details

    • interconnectId

      public final String interconnectId()

      The ID of the interconnect.

      Returns:
      The ID of the interconnect.

    • interconnectName

      public final String interconnectName()

      The name of the interconnect.

      Returns:
      The name of the interconnect.

    • interconnectState

      public final InterconnectState interconnectState()

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

      • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

      • pending: The interconnect is approved, and is being initialized.

      • available: The network link is up, and the interconnect is ready for use.

      • down: The network link is down.

      • deleting: The interconnect is being deleted.

      • deleted: The interconnect is deleted.

      • unknown: The state of the interconnect is not available.

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

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

      • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

      • pending: The interconnect is approved, and is being initialized.

      • available: The network link is up, and the interconnect is ready for use.

      • down: The network link is down.

      • deleting: The interconnect is being deleted.

      • deleted: The interconnect is deleted.

      • unknown: The state of the interconnect is not available.

      See Also:

    • interconnectStateAsString

      public final String interconnectStateAsString()

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

      • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

      • pending: The interconnect is approved, and is being initialized.

      • available: The network link is up, and the interconnect is ready for use.

      • down: The network link is down.

      • deleting: The interconnect is being deleted.

      • deleted: The interconnect is deleted.

      • unknown: The state of the interconnect is not available.

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

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

      • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

      • pending: The interconnect is approved, and is being initialized.

      • available: The network link is up, and the interconnect is ready for use.

      • down: The network link is down.

      • deleting: The interconnect is being deleted.

      • deleted: The interconnect is deleted.

      • unknown: The state of the interconnect is not available.

      See Also:

    • region

      public final String region()

      The Amazon Web Services Region where the connection is located.

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

    • location

      public final String location()

      The location of the connection.

      Returns:
      The location of the connection.

    • bandwidth

      public final String bandwidth()

      The bandwidth of the connection.

      Returns:
      The bandwidth of the connection.

    • loaIssueTime

      public final Instant loaIssueTime()

      The time of the most recent call to DescribeLoa for this connection.

      Returns:
      The time of the most recent call to DescribeLoa for this connection.

    • lagId

      public final String lagId()

      The ID of the LAG.

      Returns:
      The ID of the LAG.

    • awsDevice

      public final String awsDevice()

      The Direct Connect endpoint on which the physical connection terminates.

      Returns:
      The Direct Connect endpoint on which the physical connection terminates.

    • jumboFrameCapable

      public final Boolean jumboFrameCapable()

      Indicates whether jumbo frames are supported.

      Returns:
      Indicates whether jumbo frames are supported.

    • awsDeviceV2

      public final String awsDeviceV2()

      The Direct Connect endpoint that terminates the physical connection.

      Returns:
      The Direct Connect endpoint that terminates the physical connection.

    • awsLogicalDeviceId

      public final String awsLogicalDeviceId()

      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

      Returns:
      The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

    • hasLogicalRedundancy

      public final HasLogicalRedundancy hasLogicalRedundancy()

      Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

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

      Returns:
      Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
      See Also:

    • hasLogicalRedundancyAsString

      public final String hasLogicalRedundancyAsString()

      Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

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

      Returns:
      Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
      See Also:

    • 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 interconnect.

      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 interconnect.

    • providerName

      public final String providerName()

      The name of the service provider associated with the interconnect.

      Returns:
      The name of the service provider associated with the interconnect.

    • toBuilder

      public CreateInterconnectResponse.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<CreateInterconnectResponse.Builder,CreateInterconnectResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateInterconnectResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateInterconnectResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.