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

Class GetIpamPolicyAllocationRulesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ec2.model.Ec2Response

software.amazon.awssdk.services.ec2.model.GetIpamPolicyAllocationRulesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetIpamPolicyAllocationRulesResponse.Builder,GetIpamPolicyAllocationRulesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetIpamPolicyAllocationRulesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetIpamPolicyAllocationRulesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIpamPolicyDocuments()	For responses, this returns true if the service returned a value for the IpamPolicyDocuments property.
List<IpamPolicyDocument>	ipamPolicyDocuments()	The IPAM policy documents containing the allocation rules.
String	nextToken()	The token to use to retrieve the next page of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetIpamPolicyAllocationRulesResponse.Builder>	serializableBuilderClass()
GetIpamPolicyAllocationRulesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.ec2.model.Ec2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasIpamPolicyDocuments

public final boolean hasIpamPolicyDocuments()

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

ipamPolicyDocuments

public final List<IpamPolicyDocument> ipamPolicyDocuments()

The IPAM policy documents containing the allocation rules.

Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

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

Returns:

The IPAM policy documents containing the allocation rules.

Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

nextToken

public final String nextToken()

The token to use to retrieve the next page of results.

Returns:

The token to use to retrieve the next page of results.

toBuilder

public GetIpamPolicyAllocationRulesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetIpamPolicyAllocationRulesResponse.Builder,GetIpamPolicyAllocationRulesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetIpamPolicyAllocationRulesResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

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