AllocateHostedConnectionResponse (AWS Java SDK :: Services

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

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

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

Information about an Direct Connect connection.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AllocateHostedConnectionResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AllocateHostedConnectionResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`awsDevice()` The Direct Connect endpoint on which the physical connection terminates.
`String`	`awsDeviceV2()` The Direct Connect endpoint that terminates the physical connection.
`String`	`awsLogicalDeviceId()` The Direct Connect endpoint that terminates the logical connection.
`String`	`bandwidth()` The bandwidth of the connection.
`static AllocateHostedConnectionResponse.Builder`	`builder()`
`String`	`connectionId()` The ID of the connection.
`String`	`connectionName()` The name of the connection.
`ConnectionState`	`connectionState()` The state of the connection.
`String`	`connectionStateAsString()` The state of the connection.
`String`	`encryptionMode()` The MAC Security (MACsec) connection encryption mode.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`HasLogicalRedundancy`	`hasLogicalRedundancy()` Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
`String`	`hasLogicalRedundancyAsString()` Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
`boolean`	`hasMacSecKeys()` For responses, this returns true if the service returned a value for the MacSecKeys property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Boolean`	`jumboFrameCapable()` Indicates whether jumbo frames are supported.
`String`	`lagId()` The ID of the LAG.
`Instant`	`loaIssueTime()` The time of the most recent call to DescribeLoa for this connection.
`String`	`location()` The location of the connection.
`Boolean`	`macSecCapable()` Indicates whether the connection supports MAC Security (MACsec).
`List<MacSecKey>`	`macSecKeys()` The MAC Security (MACsec) security keys associated with the connection.
`String`	`ownerAccount()` The ID of the Amazon Web Services account that owns the connection.
`String`	`partnerName()` The name of the Direct Connect service provider associated with the connection.
`String`	`portEncryptionStatus()` The MAC Security (MACsec) port link status of the connection.
`String`	`providerName()` The name of the service provider associated with the connection.
`String`	`region()` The Amazon Web Services Region where the connection is located.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AllocateHostedConnectionResponse.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` The tags associated with the connection.
`AllocateHostedConnectionResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`vlan()` The ID of the VLAN.

Methods inherited from class software.amazon.awssdk.services.directconnect.model.DirectConnectResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    ConnectionState
  - 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:
    
    ConnectionState
  - 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:
    
    HasLogicalRedundancy
  - 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:
    
    HasLogicalRedundancy
  - 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
```
public AllocateHostedConnectionResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AllocateHostedConnectionResponse.Builder,AllocateHostedConnectionResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static AllocateHostedConnectionResponse.Builder 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AllocateHostedConnectionResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.directconnect.model.DirectConnectResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ownerAccount

connectionId

connectionName

connectionState

connectionStateAsString

region

location

bandwidth

vlan

partnerName

loaIssueTime

lagId

awsDevice

jumboFrameCapable

awsDeviceV2

awsLogicalDeviceId

hasLogicalRedundancy

hasLogicalRedundancyAsString

hasTags

tags

providerName

macSecCapable

portEncryptionStatus

encryptionMode

hasMacSecKeys

macSecKeys

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields