Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Class DescribeOptedOutNumbersResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response

software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeOptedOutNumbersResponse.Builder,DescribeOptedOutNumbersResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeOptedOutNumbersResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeOptedOutNumbersResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptedOutNumbers()	For responses, this returns true if the service returned a value for the OptedOutNumbers property.
String	nextToken()	The token to be used for the next set of paginated results.
List<OptedOutNumberInformation>	optedOutNumbers()	An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
String	optOutListArn()	The Amazon Resource Name (ARN) of the OptOutList.
String	optOutListName()	The name of the OptOutList.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeOptedOutNumbersResponse.Builder>	serializableBuilderClass()
DescribeOptedOutNumbersResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response

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

optOutListArn

public final String optOutListArn()

The Amazon Resource Name (ARN) of the OptOutList.

Returns:

The Amazon Resource Name (ARN) of the OptOutList.

optOutListName

public final String optOutListName()

The name of the OptOutList.

Returns:

The name of the OptOutList.

hasOptedOutNumbers

public final boolean hasOptedOutNumbers()

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

optedOutNumbers

public final List<OptedOutNumberInformation> optedOutNumbers()

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

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

Returns:

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

nextToken

public final String nextToken()

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

toBuilder

public DescribeOptedOutNumbersResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeOptedOutNumbersResponse.Builder,DescribeOptedOutNumbersResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeOptedOutNumbersResponse.Builder builder()

serializableBuilderClass

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