Package software.amazon.awssdk.services.ec2.model

Class CarrierGateway

java.lang.Object

software.amazon.awssdk.services.ec2.model.CarrierGateway

All Implemented Interfaces:

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

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

Describes a carrier gateway.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CarrierGateway.Builder

Method Summary

Modifier and Type	Method	Description
static CarrierGateway.Builder	builder()
String	carrierGatewayId()	The ID of the carrier gateway.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	ownerId()	The Amazon Web Services account ID of the owner of the carrier gateway.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CarrierGateway.Builder>	serializableBuilderClass()
CarrierGatewayState	state()	The state of the carrier gateway.
String	stateAsString()	The state of the carrier gateway.
List<Tag>	tags()	The tags assigned to the carrier gateway.
CarrierGateway.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vpcId()	The ID of the VPC associated with the carrier gateway.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

carrierGatewayId

public final String carrierGatewayId()

The ID of the carrier gateway.

Returns:

The ID of the carrier gateway.

vpcId

public final String vpcId()

The ID of the VPC associated with the carrier gateway.

Returns:

The ID of the VPC associated with the carrier gateway.

state

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

Returns:

The state of the carrier gateway.

See Also:

CarrierGatewayState

stateAsString

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

Returns:

The state of the carrier gateway.

See Also:

CarrierGatewayState

ownerId

public final String 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 the isEmpty() 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

public final List<Tag> 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

public CarrierGateway.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CarrierGateway.Builder,CarrierGateway>

builder

public static CarrierGateway.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo