Class CreateLagResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateLagResponse.Builder,
CreateLagResponse>
Information about a link aggregation group (LAG).
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates whether the LAG can host other connections.final String
The Direct Connect endpoint that hosts the LAG.final String
The Direct Connect endpoint that hosts the LAG.final String
The Direct Connect endpoint that terminates the logical connection.static CreateLagResponse.Builder
builder()
final List
<Connection> The connections bundled by the LAG.final String
The individual bandwidth of the physical connections bundled by the LAG.final String
The LAG MAC Security (MACsec) encryption mode.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the Connections property.final int
hashCode()
final HasLogicalRedundancy
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).final String
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).final boolean
For responses, this returns true if the service returned a value for the MacSecKeys property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
Indicates whether jumbo frames are supported.final String
lagId()
The ID of the LAG.final String
lagName()
The name of the LAG.final LagState
lagState()
The state of the LAG.final String
The state of the LAG.final String
location()
The location of the LAG.final Boolean
Indicates whether the LAG supports MAC Security (MACsec).The MAC Security (MACsec) security keys associated with the LAG.final Integer
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.final Integer
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.final String
The ID of the Amazon Web Services account that owns the LAG.final String
The name of the service provider associated with the LAG.final String
region()
The Amazon Web Services Region where the connection is located.static Class
<? extends CreateLagResponse.Builder> tags()
The tags associated with the LAG.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
connectionsBandwidth
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
- Returns:
- The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.
-
numberOfConnections
The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
- Returns:
- The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
-
lagId
The ID of the LAG.
- Returns:
- The ID of the LAG.
-
ownerAccount
The ID of the Amazon Web Services account that owns the LAG.
- Returns:
- The ID of the Amazon Web Services account that owns the LAG.
-
lagName
The name of the LAG.
- Returns:
- The name of the LAG.
-
lagState
The state of the LAG. The following are the possible values:
-
requested
: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available. -
pending
: The LAG has been approved and is being initialized. -
available
: The network link is established and the LAG is ready for use. -
down
: The network link is down. -
deleting
: The LAG is being deleted. -
deleted
: The LAG is deleted. -
unknown
: The state of the LAG is not available.
If the service returns an enum value that is not available in the current SDK version,
lagState
will returnLagState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlagStateAsString()
.- Returns:
- The state of the LAG. The following are the possible values:
-
requested
: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available. -
pending
: The LAG has been approved and is being initialized. -
available
: The network link is established and the LAG is ready for use. -
down
: The network link is down. -
deleting
: The LAG is being deleted. -
deleted
: The LAG is deleted. -
unknown
: The state of the LAG is not available.
-
- See Also:
-
-
lagStateAsString
The state of the LAG. The following are the possible values:
-
requested
: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available. -
pending
: The LAG has been approved and is being initialized. -
available
: The network link is established and the LAG is ready for use. -
down
: The network link is down. -
deleting
: The LAG is being deleted. -
deleted
: The LAG is deleted. -
unknown
: The state of the LAG is not available.
If the service returns an enum value that is not available in the current SDK version,
lagState
will returnLagState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlagStateAsString()
.- Returns:
- The state of the LAG. The following are the possible values:
-
requested
: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available. -
pending
: The LAG has been approved and is being initialized. -
available
: The network link is established and the LAG is ready for use. -
down
: The network link is down. -
deleting
: The LAG is being deleted. -
deleted
: The LAG is deleted. -
unknown
: The state of the LAG is not available.
-
- See Also:
-
-
location
The location of the LAG.
- Returns:
- The location of the LAG.
-
region
The Amazon Web Services Region where the connection is located.
- Returns:
- The Amazon Web Services Region where the connection is located.
-
minimumLinks
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
- Returns:
- The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
-
awsDevice
The Direct Connect endpoint that hosts the LAG.
- Returns:
- The Direct Connect endpoint that hosts the LAG.
-
awsDeviceV2
The Direct Connect endpoint that hosts the LAG.
- Returns:
- The Direct Connect endpoint that hosts the LAG.
-
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.
-
hasConnections
public final boolean hasConnections()For responses, this returns true if the service returned a value for the Connections property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
connections
The connections bundled by the LAG.
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
hasConnections()
method.- Returns:
- The connections bundled by the LAG.
-
allowsHostedConnections
Indicates whether the LAG can host other connections.
- Returns:
- Indicates whether the LAG can host other connections.
-
jumboFrameCapable
Indicates whether jumbo frames are supported.
- Returns:
- Indicates whether jumbo frames are supported.
-
hasLogicalRedundancy
Indicates whether the LAG 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 returnHasLogicalRedundancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhasLogicalRedundancyAsString()
.- Returns:
- Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
- See Also:
-
hasLogicalRedundancyAsString
Indicates whether the LAG 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 returnHasLogicalRedundancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhasLogicalRedundancyAsString()
.- Returns:
- Indicates whether the LAG 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 theisEmpty()
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
The tags associated with the LAG.
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 LAG.
-
providerName
The name of the service provider associated with the LAG.
- Returns:
- The name of the service provider associated with the LAG.
-
macSecCapable
Indicates whether the LAG supports MAC Security (MACsec).
- Returns:
- Indicates whether the LAG supports MAC Security (MACsec).
-
encryptionMode
The LAG MAC Security (MACsec) encryption mode.
The valid values are
no_encrypt
,should_encrypt
, andmust_encrypt
.- Returns:
- The LAG MAC Security (MACsec) encryption mode.
The valid values are
no_encrypt
,should_encrypt
, andmust_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 theisEmpty()
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
The MAC Security (MACsec) security keys associated with the LAG.
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 LAG.
-
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 interfaceToCopyableBuilder<CreateLagResponse.Builder,
CreateLagResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-