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

Class DescribeIpamScopesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeIpamScopesRequest.Builder,DescribeIpamScopesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeIpamScopesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeIpamScopesRequest.Builder	builder()
Boolean	dryRun()	A check for whether you have the required permissions for the action without actually making the request and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	One or more filters for the request.
<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	hasIpamScopeIds()	For responses, this returns true if the service returned a value for the IpamScopeIds property.
List<String>	ipamScopeIds()	The IDs of the scopes you want information on.
Integer	maxResults()	The maximum number of results to return in the request.
String	nextToken()	The token for the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeIpamScopesRequest.Builder>	serializableBuilderClass()
DescribeIpamScopesRequest.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

dryRun

public final Boolean dryRun()

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

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 for the request. For more information about filtering, see Filtering CLI output.

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 for the request. For more information about filtering, see Filtering CLI output.

maxResults

public final Integer maxResults()

The maximum number of results to return in the request.

Returns:

The maximum number of results to return in the request.

nextToken

public final String nextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

hasIpamScopeIds

public final boolean hasIpamScopeIds()

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

ipamScopeIds

public final List<String> ipamScopeIds()

The IDs of the scopes you want information on.

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

Returns:

The IDs of the scopes you want information on.

toBuilder

public DescribeIpamScopesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeIpamScopesRequest.Builder,DescribeIpamScopesRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DescribeIpamScopesRequest.Builder builder()

serializableBuilderClass

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