com.amazonaws.services.ec2.model

Class DescribeCustomerGatewaysRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest

All Implemented Interfaces:

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

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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 object for all fields except the handler context.
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.
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

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

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 device's 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> - 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.

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 device's 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> - 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.

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 device's 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> - 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.

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 device's 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> - 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.

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 device's 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> - 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.

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 device's 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> - 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.

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 device's 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> - 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.

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 device's 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> - 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.

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