Overview | Package | Class | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.amazonaws.services.ec2.model
Class DescribeCustomerGatewaysRequest

    java.lang.Object
      com.amazonaws.AmazonWebServiceRequest
          com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest

    public class DescribeCustomerGatewaysRequest

extends AmazonWebServiceRequest

Container for the parameters to the `DescribeCustomerGateways operation`.

Gives you information about your customer gateways. You can filter the results to return information only about customer gateways that match criteria you specify. For example, you could ask to get information about a particular customer gateway (or all) only if the gateway's state is pending or available. You can specify multiple filters (e.g., the customer gateway has a particular IP address for the Internet-routable external interface, and the gateway's state is pending or available). The result includes information for a particular customer gateway only if the gateway matches all your filters. If there's no match, no special message is returned; the response is simply empty. The following table shows the available filters.

See Also:
  `AmazonEC2.describeCustomerGateways(DescribeCustomerGatewaysRequest)`

Constructor Summary
`DescribeCustomerGatewaysRequest()`

Method Summary
`List<String>` | `getCustomerGatewayIds()` A set of one or more customer gateway IDs.
`List<Filter>` | `getFilters()`
`void` | `setCustomerGatewayIds(Collection<String> customerGatewayIds)` A set of one or more customer gateway IDs.
`void` | `setFilters(Collection<Filter> filters)`
`String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeCustomerGatewaysRequest` | `withCustomerGatewayIds(Collection<String> customerGatewayIds)` A set of one or more customer gateway IDs.
`DescribeCustomerGatewaysRequest` | `withCustomerGatewayIds(String... customerGatewayIds)` A set of one or more customer gateway IDs.
`DescribeCustomerGatewaysRequest` | `withFilters(Collection<Filter> filters)` Returns a reference to this object so that method calls can be chained together.
`DescribeCustomerGatewaysRequest` | `withFilters(Filter... filters)` Returns a reference to this object so that method calls can be chained together.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
`copyPrivateRequestParameters`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### DescribeCustomerGatewaysRequest

    public DescribeCustomerGatewaysRequest()

Method Detail

### getCustomerGatewayIds

    public List<String> getCustomerGatewayIds()

  A set of one or more customer gateway IDs.

  Returns:
    A set of one or more customer gateway IDs.

### setCustomerGatewayIds

    public void setCustomerGatewayIds(Collection<String> customerGatewayIds)

  A set of one or more customer gateway IDs.

  Parameters:
    `customerGatewayIds` - A set of one or more customer gateway IDs.

### withCustomerGatewayIds

    public DescribeCustomerGatewaysRequest withCustomerGatewayIds(String... customerGatewayIds)

  A set of one or more customer gateway IDs.

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

  Parameters:
    `customerGatewayIds` - A set of one or more customer gateway IDs.
  Returns:
    A reference to this updated object so that method calls can be chained together.

### withCustomerGatewayIds

    public DescribeCustomerGatewaysRequest withCustomerGatewayIds(Collection<String> customerGatewayIds)

  A set of one or more customer gateway IDs.

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

  Parameters:
    `customerGatewayIds` - A set of one or more customer gateway IDs.
  Returns:
    A reference to this updated object so that method calls can be chained together.

### getFilters

    public List<Filter> getFilters()

  Returns:

### setFilters

    public void setFilters(Collection<Filter> filters)

  Parameters:
    `filters` -

### withFilters

    public DescribeCustomerGatewaysRequest withFilters(Filter... filters)

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

  Parameters:
    `filters` -
  Returns:
    A reference to this updated object so that method calls can be chained together.

### withFilters

    public DescribeCustomerGatewaysRequest withFilters(Collection<Filter> filters)

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

  Parameters:
    `filters` -
  Returns:
    A reference to this updated object so that method calls can be chained together.

### 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()`

Overview | Package | Class | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.