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

Class DescribeOptedOutNumbersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request

software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeOptedOutNumbersRequest.Builder,DescribeOptedOutNumbersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeOptedOutNumbersRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeOptedOutNumbersRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<OptedOutFilter>	filters()	An array of OptedOutFilter objects to filter the results on.
<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	hasOptedOutNumbers()	For responses, this returns true if the service returned a value for the OptedOutNumbers property.
Integer	maxResults()	The maximum number of results to return per each request.
String	nextToken()	The token to be used for the next set of paginated results.
List<String>	optedOutNumbers()	An array of phone numbers to search for in the OptOutList.
String	optOutListName()	The OptOutListName or OptOutListArn of the OptOutList.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeOptedOutNumbersRequest.Builder>	serializableBuilderClass()
DescribeOptedOutNumbersRequest.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

optOutListName

public final String optOutListName()

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Returns:

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

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<String> optedOutNumbers()

An array of phone numbers to search for in the OptOutList.

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 phone numbers to search for in the OptOutList.

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<OptedOutFilter> filters()

An array of OptedOutFilter objects to filter the results 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 hasFilters() method.

Returns:

An array of OptedOutFilter objects to filter the results on.

nextToken

public final String nextToken()

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Returns:

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

maxResults

public final Integer maxResults()

The maximum number of results to return per each request.

Returns:

The maximum number of results to return per each request.

toBuilder

public DescribeOptedOutNumbersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeOptedOutNumbersRequest.Builder,DescribeOptedOutNumbersRequest>

Specified by:

toBuilder in class PinpointSmsVoiceV2Request

builder

public static DescribeOptedOutNumbersRequest.Builder builder()

serializableBuilderClass

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