software.amazon.awssdk.services.ec2.model

Class DescribeNatGatewaysRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeNatGatewaysRequest.Builder,DescribeNatGatewaysRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeNatGatewaysRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeNatGatewaysRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filter() One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of items to return for this request.
List<String>	natGatewayIds() One or more NAT gateway IDs.
String	nextToken() The token to retrieve the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeNatGatewaysRequest.Builder>	serializableBuilderClass()
DescribeNatGatewaysRequest.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

filter

public List<Filter> filter()

One or more filters.

• nat-gateway-id - The ID of the NAT gateway.

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

• subnet-id - The ID of the subnet in which the NAT gateway resides.

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

• vpc-id - The ID of the VPC in which the NAT gateway resides.

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

Returns:

One or more filters.

• nat-gateway-id - The ID of the NAT gateway.

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

• subnet-id - The ID of the subnet in which the NAT gateway resides.

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

• vpc-id - The ID of the VPC in which the NAT gateway resides.

maxResults

public Integer maxResults()

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

Returns:

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

natGatewayIds

public List<String> natGatewayIds()

One or more NAT gateway IDs.

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

Returns:

One or more NAT gateway IDs.

nextToken

public String nextToken()

The token to retrieve the next page of results.

Returns:

The token to retrieve the next page of results.

toBuilder

public DescribeNatGatewaysRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeNatGatewaysRequest.Builder,DescribeNatGatewaysRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeNatGatewaysRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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