com.amazonaws.services.ec2.model

Class DescribeCustomerGatewaysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<DescribeCustomerGatewaysRequest>, Serializable, Cloneable

public class DescribeCustomerGatewaysRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeCustomerGatewaysRequest>

Contains the parameters for DescribeCustomerGateways.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeCustomerGatewaysRequest()

Method Summary

Modifier and Type	Method and Description
DescribeCustomerGatewaysRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getCustomerGatewayIds() One or more customer gateway IDs.
Request<DescribeCustomerGatewaysRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
int	hashCode()
void	setCustomerGatewayIds(Collection<String> customerGatewayIds) One or more customer gateway IDs.
void	setFilters(Collection<Filter> filters) One or more filters.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeCustomerGatewaysRequest	withCustomerGatewayIds(Collection<String> customerGatewayIds) One or more customer gateway IDs.
DescribeCustomerGatewaysRequest	withCustomerGatewayIds(String... customerGatewayIds) One or more customer gateway IDs.
DescribeCustomerGatewaysRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeCustomerGatewaysRequest	withFilters(Filter... filters) One or more filters.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeCustomerGatewaysRequest

public DescribeCustomerGatewaysRequest()

Method Detail

getCustomerGatewayIds

public List<String> getCustomerGatewayIds()

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Returns:

One or more customer gateway IDs.

Default: Describes all your customer gateways.

setCustomerGatewayIds

public void setCustomerGatewayIds(Collection<String> customerGatewayIds)

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Parameters:

customerGatewayIds - One or more customer gateway IDs.

Default: Describes all your customer gateways.

withCustomerGatewayIds

public DescribeCustomerGatewaysRequest withCustomerGatewayIds(String... customerGatewayIds)

One or more customer gateway IDs.

Default: Describes all your customer gateways.

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

Parameters:

customerGatewayIds - One or more customer gateway IDs.

Default: Describes all your customer gateways.

Returns:

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

withCustomerGatewayIds

public DescribeCustomerGatewaysRequest withCustomerGatewayIds(Collection<String> customerGatewayIds)

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Parameters:

customerGatewayIds - One or more customer gateway IDs.

Default: Describes all your customer gateways.

Returns:

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

getFilters

public List<Filter> getFilters()

One or more filters.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

• ip-address - The IP address of the customer gateway's Internet-routable external interface.

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

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Returns:

One or more filters.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

• ip-address - The IP address of the customer gateway's Internet-routable external interface.

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

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

• ip-address - The IP address of the customer gateway's Internet-routable external interface.

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

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Parameters:

filters - One or more filters.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

• ip-address - The IP address of the customer gateway's Internet-routable external interface.

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

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

withFilters

public DescribeCustomerGatewaysRequest withFilters(Filter... filters)

One or more filters.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

• ip-address - The IP address of the customer gateway's Internet-routable external interface.

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

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

• ip-address - The IP address of the customer gateway's Internet-routable external interface.

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

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Returns:

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

withFilters

public DescribeCustomerGatewaysRequest withFilters(Collection<Filter> filters)

One or more filters.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

• ip-address - The IP address of the customer gateway's Internet-routable external interface.

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

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Parameters:

filters - One or more filters.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

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

• ip-address - The IP address of the customer gateway's Internet-routable external interface.

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

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

• tag:key=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Returns:

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

getDryRunRequest

public Request<DescribeCustomerGatewaysRequest> 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<DescribeCustomerGatewaysRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

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 DescribeCustomerGatewaysRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()