software.amazon.awssdk.services.directconnect.model

Class CreateLagResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLagResponse.Builder,CreateLagResponse>

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

Information about a link aggregation group (LAG).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLagResponse.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowsHostedConnections() Indicates whether the LAG can host other connections.
String	awsDevice() The AWS Direct Connect endpoint that hosts the LAG.
String	awsDeviceV2() The AWS Direct Connect endpoint that hosts the LAG.
static CreateLagResponse.Builder	builder()
List<Connection>	connections() The connections bundled by the LAG.
String	connectionsBandwidth() The individual bandwidth of the physical connections bundled by the LAG.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
boolean	hasConnections() Returns true if the Connections property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
HasLogicalRedundancy	hasLogicalRedundancy() Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
String	hasLogicalRedundancyAsString() Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Boolean	jumboFrameCapable() Indicates whether jumbo frames (9001 MTU) are supported.
String	lagId() The ID of the LAG.
String	lagName() The name of the LAG.
LagState	lagState() The state of the LAG.
String	lagStateAsString() The state of the LAG.
String	location() The location of the LAG.
Integer	minimumLinks() The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
Integer	numberOfConnections() The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
String	ownerAccount() The ID of the AWS account that owns the LAG.
String	providerName() The name of the service provider associated with the LAG.
String	region() The AWS Region where the connection is located.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLagResponse.Builder>	serializableBuilderClass()
List<Tag>	tags() The tags associated with the LAG.
CreateLagResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

connectionsBandwidth

public final String 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

public final Integer 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

public final String lagId()

The ID of the LAG.

Returns:

The ID of the LAG.

ownerAccount

public final String ownerAccount()

The ID of the AWS account that owns the LAG.

Returns:

The ID of the AWS account that owns the LAG.

lagName

public final String lagName()

The name of the LAG.

Returns:

The name of the LAG.

lagState

public final LagState 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 return LagState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lagStateAsString().

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:

LagState

lagStateAsString

public final String 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 return LagState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lagStateAsString().

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:

LagState

location

public final String location()

The location of the LAG.

Returns:

The location of the LAG.

region

public final String region()

The AWS Region where the connection is located.

Returns:

The AWS Region where the connection is located.

minimumLinks

public final Integer 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

public final String awsDevice()

The AWS Direct Connect endpoint that hosts the LAG.

Returns:

The AWS Direct Connect endpoint that hosts the LAG.

awsDeviceV2

public final String awsDeviceV2()

The AWS Direct Connect endpoint that hosts the LAG.

Returns:

The AWS Direct Connect endpoint that hosts the LAG.

hasConnections

public final boolean hasConnections()

Returns true if the Connections property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

connections

public final List<Connection> connections()

The connections bundled by the LAG.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasConnections() to see if a value was sent in this field.

Returns:

The connections bundled by the LAG.

allowsHostedConnections

public final Boolean allowsHostedConnections()

Indicates whether the LAG can host other connections.

Returns:

Indicates whether the LAG can host other connections.

jumboFrameCapable

public final Boolean jumboFrameCapable()

Indicates whether jumbo frames (9001 MTU) are supported.

Returns:

Indicates whether jumbo frames (9001 MTU) are supported.

hasLogicalRedundancy

public final HasLogicalRedundancy 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 return HasLogicalRedundancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hasLogicalRedundancyAsString().

Returns:

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

See Also:

HasLogicalRedundancy

hasLogicalRedundancyAsString

public final String 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 return HasLogicalRedundancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hasLogicalRedundancyAsString().

Returns:

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

See Also:

HasLogicalRedundancy

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

The tags associated with the LAG.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags associated with the LAG.

providerName

public final String providerName()

The name of the service provider associated with the LAG.

Returns:

The name of the service provider associated with the LAG.

toBuilder

public CreateLagResponse.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<CreateLagResponse.Builder,CreateLagResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static CreateLagResponse.Builder builder()

serializableBuilderClass

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