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)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filter() One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilter() For responses, this returns true if the service returned a value for the Filter property.
int	hashCode()
boolean	hasNatGatewayIds() For responses, this returns true if the service returned a value for the NatGatewayIds property.
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 returned from a previous paginated request.
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

hasFilter

public final boolean hasFilter()

For responses, this returns true if the service returned a value for the Filter property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filter

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilter() method.

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 final Integer maxResults()

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Returns:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

hasNatGatewayIds

public final boolean hasNatGatewayIds()

For responses, this returns true if the service returned a value for the NatGatewayIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

natGatewayIds

public final List<String> natGatewayIds()

One or more NAT gateway IDs.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNatGatewayIds() method.

Returns:

One or more NAT gateway IDs.

nextToken

public final String nextToken()

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo