Class CarrierGateway
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CarrierGateway.Builder,
CarrierGateway>
Describes a carrier gateway.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CarrierGateway.Builder
builder()
final String
The ID of the carrier 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
ownerId()
The Amazon Web Services account ID of the owner of the carrier gateway.static Class
<? extends CarrierGateway.Builder> final CarrierGatewayState
state()
The state of the carrier gateway.final String
The state of the carrier gateway.tags()
The tags assigned to the carrier 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 String
vpcId()
The ID of the VPC associated with the carrier gateway.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
carrierGatewayId
The ID of the carrier gateway.
- Returns:
- The ID of the carrier gateway.
-
vpcId
The ID of the VPC associated with the carrier gateway.
- Returns:
- The ID of the VPC associated with the carrier gateway.
-
state
The state of the carrier gateway.
If the service returns an enum value that is not available in the current SDK version,
state
will returnCarrierGatewayState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the carrier gateway.
- See Also:
-
stateAsString
The state of the carrier gateway.
If the service returns an enum value that is not available in the current SDK version,
state
will returnCarrierGatewayState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the carrier gateway.
- See Also:
-
ownerId
The Amazon Web Services account ID of the owner of the carrier gateway.
- Returns:
- The Amazon Web Services account ID of the owner of the carrier gateway.
-
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 assigned to the carrier 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:
- The tags assigned to the carrier 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<CarrierGateway.Builder,
CarrierGateway> - 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
-