Class DirectConnectGateway
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Long
The autonomous system number (ASN) for the Amazon side of the connection.static DirectConnectGateway.Builder
builder()
final String
The ID of the Direct Connect gateway.final String
The name of the Direct Connect gateway.The state of the Direct Connect gateway.final String
The state of the Direct Connect gateway.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) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The ID of the Amazon Web Services account that owns the Direct Connect gateway.static Class
<? extends DirectConnectGateway.Builder> final String
The error message if the state of an object failed to advance.tags()
Information about a tag.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
directConnectGatewayId
The ID of the Direct Connect gateway.
- Returns:
- The ID of the Direct Connect gateway.
-
directConnectGatewayName
The name of the Direct Connect gateway.
- Returns:
- The name of the Direct Connect gateway.
-
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
The ID of the Amazon Web Services account that owns the Direct Connect gateway.
- Returns:
- The ID of the Amazon Web Services account that owns the Direct Connect gateway.
-
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 returnDirectConnectGatewayState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectConnectGatewayStateAsString()
.- 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:
-
-
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 returnDirectConnectGatewayState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdirectConnectGatewayStateAsString()
.- 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:
-
-
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.
-
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
Information about a tag.
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:
- Information about a tag.
-
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<DirectConnectGateway.Builder,
DirectConnectGateway> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-