Class CreatePoolResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreatePoolResponse.Builder,
CreatePoolResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CreatePoolResponse.Builder
builder()
final Instant
The time when the pool was created, in UNIX epoch time format.final Boolean
When set to true deletion protection is enabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final MessageType
The type of message for the pool to use.final String
The type of message for the pool to use.final String
The name of the OptOutList associated with the pool.final String
poolArn()
The Amazon Resource Name (ARN) for the pool.final String
poolId()
The unique identifier for the pool.final Boolean
By default this is set to false.static Class
<? extends CreatePoolResponse.Builder> final Boolean
Indicates whether shared routes are enabled for the pool.final PoolStatus
status()
The current status of the pool.final String
The current status of the pool.tags()
An array of tags (key and value pairs) associated with the pool.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The Amazon Resource Name (ARN) of the two way channel.final String
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.final Boolean
By default this is set to false.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
poolArn
The Amazon Resource Name (ARN) for the pool.
- Returns:
- The Amazon Resource Name (ARN) for the pool.
-
poolId
The unique identifier for the pool.
- Returns:
- The unique identifier for the pool.
-
status
The current status of the pool.
-
CREATING: The pool is currently being created and isn't yet available for use.
-
ACTIVE: The pool is active and available for use.
-
DELETING: The pool is being deleted.
If the service returns an enum value that is not available in the current SDK version,
status
will returnPoolStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the pool.
-
CREATING: The pool is currently being created and isn't yet available for use.
-
ACTIVE: The pool is active and available for use.
-
DELETING: The pool is being deleted.
-
- See Also:
-
-
statusAsString
The current status of the pool.
-
CREATING: The pool is currently being created and isn't yet available for use.
-
ACTIVE: The pool is active and available for use.
-
DELETING: The pool is being deleted.
If the service returns an enum value that is not available in the current SDK version,
status
will returnPoolStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the pool.
-
CREATING: The pool is currently being created and isn't yet available for use.
-
ACTIVE: The pool is active and available for use.
-
DELETING: The pool is being deleted.
-
- See Also:
-
-
messageType
The type of message for the pool to use.
If the service returns an enum value that is not available in the current SDK version,
messageType
will returnMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageTypeAsString()
.- Returns:
- The type of message for the pool to use.
- See Also:
-
messageTypeAsString
The type of message for the pool to use.
If the service returns an enum value that is not available in the current SDK version,
messageType
will returnMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageTypeAsString()
.- Returns:
- The type of message for the pool to use.
- See Also:
-
twoWayEnabled
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- Returns:
- By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
-
twoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
- Returns:
- The Amazon Resource Name (ARN) of the two way channel.
-
twoWayChannelRole
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
- Returns:
- An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
-
selfManagedOptOutsEnabled
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
- Returns:
- By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
-
optOutListName
The name of the OptOutList associated with the pool.
- Returns:
- The name of the OptOutList associated with the pool.
-
deletionProtectionEnabled
When set to true deletion protection is enabled. By default this is set to false.
- Returns:
- When set to true deletion protection is enabled. By default this is set to false.
-
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 theisEmpty()
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
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.
-
createdTimestamp
The time when the pool was created, in UNIX epoch time format.
- Returns:
- The time when the pool was created, in UNIX epoch time format.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreatePoolResponse.Builder,
CreatePoolResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-