software.amazon.awssdk.services.ec2.model

Class DescribeCustomerGatewaysRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DescribeCustomerGatewaysRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCustomerGatewaysRequest.Builder,DescribeCustomerGatewaysRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeCustomerGatewaysRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeCustomerGatewaysRequest.Builder,DescribeCustomerGatewaysRequest>

Contains the parameters for DescribeCustomerGateways.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCustomerGatewaysRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCustomerGatewaysRequest.Builder	builder()
List<String>	customerGatewayIds() One or more customer gateway IDs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCustomerGatewayIds() Returns true if the CustomerGatewayIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasFilters() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCustomerGatewaysRequest.Builder>	serializableBuilderClass()
DescribeCustomerGatewaysRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasCustomerGatewayIds

public boolean hasCustomerGatewayIds()

Returns true if the CustomerGatewayIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

customerGatewayIds

public List<String> customerGatewayIds()

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasCustomerGatewayIds() to see if a value was sent in this field.

Returns:

One or more customer gateway IDs.

Default: Describes all your customer gateways.

hasFilters

public boolean hasFilters()

Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filters

public List<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> - 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilters() to see if a value was sent in this field.

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> - 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.

toBuilder

public DescribeCustomerGatewaysRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCustomerGatewaysRequest.Builder,DescribeCustomerGatewaysRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeCustomerGatewaysRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeCustomerGatewaysRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo