software.amazon.awssdk.services.directconnect.model

Class DirectConnectGateway

java.lang.Object

software.amazon.awssdk.services.directconnect.model.DirectConnectGateway

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DirectConnectGateway.Builder,DirectConnectGateway>

@Generated(value="software.amazon.awssdk:codegen")
public final class DirectConnectGateway
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DirectConnectGateway.Builder,DirectConnectGateway>

Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DirectConnectGateway.Builder

Method Summary

Modifier and Type	Method and Description
Long	amazonSideAsn() The autonomous system number (ASN) for the Amazon side of the connection.
static DirectConnectGateway.Builder	builder()
String	directConnectGatewayId() The ID of the Direct Connect gateway.
String	directConnectGatewayName() The name of the Direct Connect gateway.
DirectConnectGatewayState	directConnectGatewayState() The state of the Direct Connect gateway.
String	directConnectGatewayStateAsString() The state of the Direct Connect gateway.
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)
int	hashCode()
String	ownerAccount() The ID of the account that owns the Direct Connect gateway.
List<SdkField<?>>	sdkFields()
static Class<? extends DirectConnectGateway.Builder>	serializableBuilderClass()
String	stateChangeError() The error message if the state of an object failed to advance.
DirectConnectGateway.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

directConnectGatewayId

public final String directConnectGatewayId()

The ID of the Direct Connect gateway.

Returns:

The ID of the Direct Connect gateway.

directConnectGatewayName

public final String directConnectGatewayName()

The name of the Direct Connect gateway.

Returns:

The name of the Direct Connect gateway.

amazonSideAsn

public final Long amazonSideAsn()

The autonomous system number (ASN) for the Amazon side of the connection.

Returns:

The autonomous system number (ASN) for the Amazon side of the connection.

ownerAccount

public final String ownerAccount()

The ID of the account that owns the Direct Connect gateway.

Returns:

The ID of the account that owns the Direct Connect gateway.

directConnectGatewayState

public final DirectConnectGatewayState directConnectGatewayState()

The state of the Direct Connect gateway. The following are the possible values:

• pending: The initial state after calling CreateDirectConnectGateway.

• available: The Direct Connect gateway is ready for use.

• deleting: The initial state after calling DeleteDirectConnectGateway.

• deleted: The Direct Connect gateway is deleted and cannot pass traffic.

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

Returns:

The state of the Direct Connect gateway. The following are the possible values:

• pending: The initial state after calling CreateDirectConnectGateway.

• available: The Direct Connect gateway is ready for use.

• deleting: The initial state after calling DeleteDirectConnectGateway.

• deleted: The Direct Connect gateway is deleted and cannot pass traffic.

See Also:

DirectConnectGatewayState

directConnectGatewayStateAsString

public final String directConnectGatewayStateAsString()

The state of the Direct Connect gateway. The following are the possible values:

• pending: The initial state after calling CreateDirectConnectGateway.

• available: The Direct Connect gateway is ready for use.

• deleting: The initial state after calling DeleteDirectConnectGateway.

• deleted: The Direct Connect gateway is deleted and cannot pass traffic.

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

Returns:

The state of the Direct Connect gateway. The following are the possible values:

• pending: The initial state after calling CreateDirectConnectGateway.

• available: The Direct Connect gateway is ready for use.

• deleting: The initial state after calling DeleteDirectConnectGateway.

• deleted: The Direct Connect gateway is deleted and cannot pass traffic.

See Also:

DirectConnectGatewayState

stateChangeError

public final String stateChangeError()

The error message if the state of an object failed to advance.

Returns:

The error message if the state of an object failed to advance.

toBuilder

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

Returns:

a builder for type T

builder

public static DirectConnectGateway.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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.