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

Class GetIpamPolicyAllocationRulesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetIpamPolicyAllocationRulesRequest.Builder,GetIpamPolicyAllocationRulesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetIpamPolicyAllocationRulesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetIpamPolicyAllocationRulesRequest.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 allocation rules.
<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()
String	ipamPolicyId()	The ID of the IPAM policy for which to get allocation rules.
String	locale()	The locale for which to get the allocation rules.
Integer	maxResults()	The maximum number of results to return in a single call.
String	nextToken()	The token for the next page of results.
IpamPolicyResourceType	resourceType()	The resource type for which to get the allocation rules.
String	resourceTypeAsString()	The resource type for which to get the allocation rules.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetIpamPolicyAllocationRulesRequest.Builder>	serializableBuilderClass()
GetIpamPolicyAllocationRulesRequest.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.

ipamPolicyId

public final String ipamPolicyId()

The ID of the IPAM policy for which to get allocation rules.

Returns:

The ID of the IPAM policy for which to get allocation rules.

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

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

locale

public final String locale()

The locale for which to get the allocation rules.

Returns:

The locale for which to get the allocation rules.

resourceType

public final IpamPolicyResourceType resourceType()

The resource type for which to get the allocation rules.

The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

• Elastic IP addresses

If the service returns an enum value that is not available in the current SDK version, resourceType will return IpamPolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

The resource type for which to get the allocation rules.

The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

• Elastic IP addresses

See Also:

IpamPolicyResourceType

resourceTypeAsString

public final String resourceTypeAsString()

The resource type for which to get the allocation rules.

The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

• Elastic IP addresses

If the service returns an enum value that is not available in the current SDK version, resourceType will return IpamPolicyResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

The resource type for which to get the allocation rules.

The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

• Elastic IP addresses

See Also:

IpamPolicyResourceType

maxResults

public final Integer maxResults()

The maximum number of results to return in a single call.

Returns:

The maximum number of results to return in a single call.

nextToken

public final String nextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

toBuilder

public GetIpamPolicyAllocationRulesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetIpamPolicyAllocationRulesRequest.Builder,GetIpamPolicyAllocationRulesRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static GetIpamPolicyAllocationRulesRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo