software.amazon.awssdk.services.ec2.model

Class DescribeCarrierGatewaysRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DescribeCarrierGatewaysRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCarrierGatewaysRequest.Builder,DescribeCarrierGatewaysRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeCarrierGatewaysRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeCarrierGatewaysRequest.Builder,DescribeCarrierGatewaysRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCarrierGatewaysRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCarrierGatewaysRequest.Builder	builder()
List<String>	carrierGatewayIds() One or more carrier gateway IDs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCarrierGatewayIds() Returns true if the CarrierGatewayIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasFilters() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Integer	maxResults() The maximum number of results to return with a single call.
String	nextToken() The token for the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCarrierGatewaysRequest.Builder>	serializableBuilderClass()
DescribeCarrierGatewaysRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

hasCarrierGatewayIds

public boolean hasCarrierGatewayIds()

Returns true if the CarrierGatewayIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

carrierGatewayIds

public List<String> carrierGatewayIds()

One or more carrier gateway IDs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasCarrierGatewayIds() to see if a value was sent in this field.

Returns:

One or more carrier gateway IDs.

hasFilters

public boolean hasFilters()

Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filters

public List<Filter> filters()

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier gateway.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC associated with the carrier gateway.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilters() to see if a value was sent in this field.

Returns:

One or more filters.

• carrier-gateway-id - The ID of the carrier gateway.

• state - The state of the carrier gateway (pending | failed | available | deleting | deleted).

• owner-id - The AWS account ID of the owner of the carrier gateway.

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC associated with the carrier gateway.

maxResults

public Integer maxResults()

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

nextToken

public String nextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

toBuilder

public DescribeCarrierGatewaysRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCarrierGatewaysRequest.Builder,DescribeCarrierGatewaysRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeCarrierGatewaysRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo