public class DescribeCustomerGatewaysRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable, DryRunSupportedRequest<DescribeCustomerGatewaysRequest>
Contains the parameters for DescribeCustomerGateways.
Modifier and Type | Field and Description |
---|---|
private SdkInternalList<java.lang.String> |
customerGatewayIds
One or more customer gateway IDs.
|
private SdkInternalList<Filter> |
filters
One or more filters.
|
NOOP
Constructor and Description |
---|
DescribeCustomerGatewaysRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeCustomerGatewaysRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getCustomerGatewayIds()
One or more customer gateway IDs.
|
Request<DescribeCustomerGatewaysRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
java.util.List<Filter> |
getFilters()
One or more filters.
|
int |
hashCode() |
void |
setCustomerGatewayIds(java.util.Collection<java.lang.String> customerGatewayIds)
One or more customer gateway IDs.
|
void |
setFilters(java.util.Collection<Filter> filters)
One or more filters.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeCustomerGatewaysRequest |
withCustomerGatewayIds(java.util.Collection<java.lang.String> customerGatewayIds)
One or more customer gateway IDs.
|
DescribeCustomerGatewaysRequest |
withCustomerGatewayIds(java.lang.String... customerGatewayIds)
One or more customer gateway IDs.
|
DescribeCustomerGatewaysRequest |
withFilters(java.util.Collection<Filter> filters)
One or more filters.
|
DescribeCustomerGatewaysRequest |
withFilters(Filter... filters)
One or more filters.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private SdkInternalList<java.lang.String> customerGatewayIds
One or more customer gateway IDs.
Default: Describes all your customer gateways.
private SdkInternalList<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.
public java.util.List<java.lang.String> getCustomerGatewayIds()
One or more customer gateway IDs.
Default: Describes all your customer gateways.
Default: Describes all your customer gateways.
public void setCustomerGatewayIds(java.util.Collection<java.lang.String> customerGatewayIds)
One or more customer gateway IDs.
Default: Describes all your customer gateways.
customerGatewayIds
- One or more customer gateway IDs.
Default: Describes all your customer gateways.
public DescribeCustomerGatewaysRequest withCustomerGatewayIds(java.lang.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.
customerGatewayIds
- One or more customer gateway IDs.
Default: Describes all your customer gateways.
public DescribeCustomerGatewaysRequest withCustomerGatewayIds(java.util.Collection<java.lang.String> customerGatewayIds)
One or more customer gateway IDs.
Default: Describes all your customer gateways.
customerGatewayIds
- One or more customer gateway IDs.
Default: Describes all your customer gateways.
public java.util.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.
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.
public void setFilters(java.util.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.
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.
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.
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.
public DescribeCustomerGatewaysRequest withFilters(java.util.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.
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.
public Request<DescribeCustomerGatewaysRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<DescribeCustomerGatewaysRequest>
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeCustomerGatewaysRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()