software.amazon.awssdk.services.pinpointsmsvoicev2.model

Class CreatePoolRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePoolRequest.Builder,CreatePoolRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreatePoolRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreatePoolRequest.Builder	builder()
String	clientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Boolean	deletionProtectionEnabled() By default this is set to false.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	isoCountryCode() The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
MessageType	messageType() The type of message.
String	messageTypeAsString() The type of message.
String	originationIdentity() The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePoolRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() An array of tags (key and value pairs) associated with the pool.
CreatePoolRequest.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

originationIdentity

public final String originationIdentity()

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

Returns:

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

isoCountryCode

public final String isoCountryCode()

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

Returns:

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

messageType

public final MessageType messageType()

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

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

Returns:

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

See Also:

MessageType

messageTypeAsString

public final String messageTypeAsString()

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

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

Returns:

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

See Also:

MessageType

deletionProtectionEnabled

public final Boolean deletionProtectionEnabled()

By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

Returns:

By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

An array of tags (key and value pairs) associated with the pool.

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

Returns:

An array of tags (key and value pairs) associated with the pool.

clientToken

public final String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

toBuilder

public CreatePoolRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePoolRequest.Builder,CreatePoolRequest>

Specified by:

toBuilder in class PinpointSmsVoiceV2Request

builder

public static CreatePoolRequest.Builder builder()

serializableBuilderClass

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