software.amazon.awssdk.services.ec2.model

Interface DescribeCarrierGatewaysRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeCarrierGatewaysRequest.Builder,DescribeCarrierGatewaysRequest>, Ec2Request.Builder, SdkBuilder<DescribeCarrierGatewaysRequest.Builder,DescribeCarrierGatewaysRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeCarrierGatewaysRequest

public static interface DescribeCarrierGatewaysRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeCarrierGatewaysRequest.Builder,DescribeCarrierGatewaysRequest>

Method Summary

Modifier and Type	Method and Description
DescribeCarrierGatewaysRequest.Builder	carrierGatewayIds(Collection<String> carrierGatewayIds) One or more carrier gateway IDs.
DescribeCarrierGatewaysRequest.Builder	carrierGatewayIds(String... carrierGatewayIds) One or more carrier gateway IDs.
DescribeCarrierGatewaysRequest.Builder	filters(Collection<Filter> filters) One or more filters.
DescribeCarrierGatewaysRequest.Builder	filters(Consumer<Filter.Builder>... filters) One or more filters.
DescribeCarrierGatewaysRequest.Builder	filters(Filter... filters) One or more filters.
DescribeCarrierGatewaysRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return with a single call.
DescribeCarrierGatewaysRequest.Builder	nextToken(String nextToken) The token for the next page of results.
DescribeCarrierGatewaysRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeCarrierGatewaysRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

carrierGatewayIds

DescribeCarrierGatewaysRequest.Builder carrierGatewayIds(Collection<String> carrierGatewayIds)

One or more carrier gateway IDs.

Parameters:

carrierGatewayIds - One or more carrier gateway IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

carrierGatewayIds

DescribeCarrierGatewaysRequest.Builder carrierGatewayIds(String... carrierGatewayIds)

One or more carrier gateway IDs.

Parameters:

carrierGatewayIds - One or more carrier gateway IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeCarrierGatewaysRequest.Builder filters(Collection<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 Amazon Web Services 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.

Parameters:

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 Amazon Web Services 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeCarrierGatewaysRequest.Builder filters(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 Amazon Web Services 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.

Parameters:

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 Amazon Web Services 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeCarrierGatewaysRequest.Builder filters(Consumer<Filter.Builder>... 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 Amazon Web Services 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.

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on Filter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(java.util.Collection)

maxResults

DescribeCarrierGatewaysRequest.Builder maxResults(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

nextToken

DescribeCarrierGatewaysRequest.Builder nextToken(String nextToken)

The token for the next page of results.

Parameters:

nextToken - The token for the next page of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

DescribeCarrierGatewaysRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeCarrierGatewaysRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder