Package software.amazon.awssdk.services.ec2.model

Class DescribePublicIpv4PoolsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribePublicIpv4PoolsRequest.Builder,DescribePublicIpv4PoolsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribePublicIpv4PoolsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribePublicIpv4PoolsRequest.Builder	builder()
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	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
boolean	hasPoolIds()	For responses, this returns true if the service returned a value for the PoolIds property.
Integer	maxResults()	The maximum number of results to return with a single call.
String	nextToken()	The token for the next page of results.
List<String>	poolIds()	The IDs of the address pools.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribePublicIpv4PoolsRequest.Builder>	serializableBuilderClass()
DescribePublicIpv4PoolsRequest.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

hasPoolIds

public final boolean hasPoolIds()

For responses, this returns true if the service returned a value for the PoolIds 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.

poolIds

public final List<String> poolIds()

The IDs of the address pools.

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 hasPoolIds() method.

Returns:

The IDs of the address pools.

nextToken

public final String nextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

maxResults

public final Integer maxResults()

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Returns:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final List<Filter> filters()

One or more filters.

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

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 hasFilters() method.

Returns:

One or more filters.

• 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 DescribePublicIpv4PoolsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribePublicIpv4PoolsRequest.Builder,DescribePublicIpv4PoolsRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribePublicIpv4PoolsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribePublicIpv4PoolsRequest.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