Class AllocateHostedConnectionResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AllocateHostedConnectionResponse.Builder,AllocateHostedConnectionResponse>

@Generated("software.amazon.awssdk:codegen") public final class AllocateHostedConnectionResponse extends DirectConnectResponse implements ToCopyableBuilder<AllocateHostedConnectionResponse.Builder,AllocateHostedConnectionResponse>

Information about an Direct Connect connection.

  • Method Details

    • ownerAccount

      public final String ownerAccount()

      The ID of the Amazon Web Services account that owns the connection.

      Returns:
      The ID of the Amazon Web Services account that owns the connection.
    • connectionId

      public final String connectionId()

      The ID of the connection.

      Returns:
      The ID of the connection.
    • connectionName

      public final String connectionName()

      The name of the connection.

      Returns:
      The name of the connection.
    • connectionState

      public final ConnectionState connectionState()

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

      • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

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

      • pending: The connection has been approved and is being initialized.

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

      • down: The network link is down.

      • deleting: The connection is being deleted.

      • deleted: The connection has been deleted.

      • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

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

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

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

      • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

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

      • pending: The connection has been approved and is being initialized.

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

      • down: The network link is down.

      • deleting: The connection is being deleted.

      • deleted: The connection has been deleted.

      • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

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

      See Also:
    • connectionStateAsString

      public final String connectionStateAsString()

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

      • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

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

      • pending: The connection has been approved and is being initialized.

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

      • down: The network link is down.

      • deleting: The connection is being deleted.

      • deleted: The connection has been deleted.

      • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

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

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

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

      • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

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

      • pending: The connection has been approved and is being initialized.

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

      • down: The network link is down.

      • deleting: The connection is being deleted.

      • deleted: The connection has been deleted.

      • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

      • unknown: The state of the connection 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.
    • vlan

      public final Integer vlan()

      The ID of the VLAN.

      Returns:
      The ID of the VLAN.
    • partnerName

      public final String partnerName()

      The name of the Direct Connect service provider associated with the connection.

      Returns:
      The name of the Direct Connect service provider associated with 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 connection supports a secondary BGP peer 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 connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
      See Also:
    • hasLogicalRedundancyAsString

      public final String hasLogicalRedundancyAsString()

      Indicates whether the connection supports a secondary BGP peer 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 connection supports a secondary BGP peer 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 connection.

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

      public final String providerName()

      The name of the service provider associated with the connection.

      Returns:
      The name of the service provider associated with the connection.
    • macSecCapable

      public final Boolean macSecCapable()

      Indicates whether the connection supports MAC Security (MACsec).

      Returns:
      Indicates whether the connection supports MAC Security (MACsec).
    • portEncryptionStatus

      public final String portEncryptionStatus()

      The MAC Security (MACsec) port link status of the connection.

      The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

      Returns:
      The MAC Security (MACsec) port link status of the connection.

      The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

    • encryptionMode

      public final String encryptionMode()

      The MAC Security (MACsec) connection encryption mode.

      The valid values are no_encrypt, should_encrypt, and must_encrypt.

      Returns:
      The MAC Security (MACsec) connection encryption mode.

      The valid values are no_encrypt, should_encrypt, and must_encrypt.

    • hasMacSecKeys

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

      public final List<MacSecKey> macSecKeys()

      The MAC Security (MACsec) security keys associated with the connection.

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

      Returns:
      The MAC Security (MACsec) security keys associated with the connection.
    • 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<AllocateHostedConnectionResponse.Builder,AllocateHostedConnectionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

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