Class VpnGateway
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VpnGateway.Builder,
VpnGateway>
Describes a virtual private gateway.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Long
The private Autonomous System Number (ASN) for the Amazon side of a BGP session.final String
The Availability Zone where the virtual private gateway was created, if applicable.static VpnGateway.Builder
builder()
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 boolean
For responses, this returns true if the service returned a value for the VpcAttachments property.static Class
<? extends VpnGateway.Builder> final VpnState
state()
The current state of the virtual private gateway.final String
The current state of the virtual private gateway.tags()
Any tags assigned to the virtual private gateway.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.final GatewayType
type()
The type of VPN connection the virtual private gateway supports.final String
The type of VPN connection the virtual private gateway supports.final List
<VpcAttachment> Any VPCs attached to the virtual private gateway.final String
The ID of the virtual private gateway.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
availabilityZone
The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
- Returns:
- The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.
-
state
The current state of the virtual private gateway.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVpnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the virtual private gateway.
- See Also:
-
stateAsString
The current state of the virtual private gateway.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVpnState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the virtual private gateway.
- See Also:
-
type
The type of VPN connection the virtual private gateway supports.
If the service returns an enum value that is not available in the current SDK version,
type
will returnGatewayType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of VPN connection the virtual private gateway supports.
- See Also:
-
typeAsString
The type of VPN connection the virtual private gateway supports.
If the service returns an enum value that is not available in the current SDK version,
type
will returnGatewayType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of VPN connection the virtual private gateway supports.
- See Also:
-
hasVpcAttachments
public final boolean hasVpcAttachments()For responses, this returns true if the service returned a value for the VpcAttachments 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. -
vpcAttachments
Any VPCs attached to the virtual private gateway.
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
hasVpcAttachments()
method.- Returns:
- Any VPCs attached to the virtual private gateway.
-
vpnGatewayId
The ID of the virtual private gateway.
- Returns:
- The ID of the virtual private gateway.
-
amazonSideAsn
The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- Returns:
- The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
-
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
Any tags assigned to the virtual private gateway.
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:
- Any tags assigned to the virtual private gateway.
-
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<VpnGateway.Builder,
VpnGateway> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int 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
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
-
sdkFields
-