com.amazonaws.services.ec2.model

Class DescribeCarrierGatewaysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeCarrierGatewaysRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeCarrierGatewaysRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeCarrierGatewaysRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeCarrierGatewaysRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeCarrierGatewaysRequest()

Method Summary

Modifier and Type	Method and Description
DescribeCarrierGatewaysRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getCarrierGatewayIds() One or more carrier gateway IDs.
Request<DescribeCarrierGatewaysRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
Integer	getMaxResults() The maximum number of results to return with a single call.
String	getNextToken() The token for the next page of results.
int	hashCode()
void	setCarrierGatewayIds(Collection<String> carrierGatewayIds) One or more carrier gateway IDs.
void	setFilters(Collection<Filter> filters) One or more filters.
void	setMaxResults(Integer maxResults) The maximum number of results to return with a single call.
void	setNextToken(String nextToken) The token for the next page of results.
String	toString() Returns a string representation of this object.
DescribeCarrierGatewaysRequest	withCarrierGatewayIds(Collection<String> carrierGatewayIds) One or more carrier gateway IDs.
DescribeCarrierGatewaysRequest	withCarrierGatewayIds(String... carrierGatewayIds) One or more carrier gateway IDs.
DescribeCarrierGatewaysRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeCarrierGatewaysRequest	withFilters(Filter... filters) One or more filters.
DescribeCarrierGatewaysRequest	withMaxResults(Integer maxResults) The maximum number of results to return with a single call.
DescribeCarrierGatewaysRequest	withNextToken(String nextToken) The token for the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeCarrierGatewaysRequest

public DescribeCarrierGatewaysRequest()

Method Detail

getCarrierGatewayIds

public List<String> getCarrierGatewayIds()

One or more carrier gateway IDs.

Returns:

One or more carrier gateway IDs.

setCarrierGatewayIds

public void setCarrierGatewayIds(Collection<String> carrierGatewayIds)

One or more carrier gateway IDs.

Parameters:

carrierGatewayIds - One or more carrier gateway IDs.

withCarrierGatewayIds

public DescribeCarrierGatewaysRequest withCarrierGatewayIds(String... carrierGatewayIds)

One or more carrier gateway IDs.

NOTE: This method appends the values to the existing list (if any). Use setCarrierGatewayIds(java.util.Collection) or withCarrierGatewayIds(java.util.Collection) if you want to override the existing values.

Parameters:

carrierGatewayIds - One or more carrier gateway IDs.

Returns:

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

withCarrierGatewayIds

public DescribeCarrierGatewaysRequest withCarrierGatewayIds(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.

getFilters

public List<Filter> getFilters()

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:

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.

setFilters

public void setFilters(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.

withFilters

public DescribeCarrierGatewaysRequest withFilters(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.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

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.

withFilters

public DescribeCarrierGatewaysRequest withFilters(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public DescribeCarrierGatewaysRequest withMaxResults(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.

setNextToken

public void setNextToken(String nextToken)

The token for the next page of results.

Parameters:

nextToken - The token for the next page of results.

getNextToken

public String getNextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

withNextToken

public DescribeCarrierGatewaysRequest withNextToken(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.

getDryRunRequest

public Request<DescribeCarrierGatewaysRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeCarrierGatewaysRequest>

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeCarrierGatewaysRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()