Class UpdatePoolRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdatePoolRequest.Builder,
UpdatePoolRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UpdatePoolRequest.Builder
builder()
final Boolean
When set to true the pool can't be deleted.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 extendsSdkRequest
.final int
hashCode()
final String
The OptOutList to associate with the pool.final String
poolId()
The unique identifier of the pool to update.final Boolean
By default this is set to false.static Class
<? extends UpdatePoolRequest.Builder> final Boolean
Indicates whether shared routes are enabled for 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.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
poolId
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
- Returns:
- The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
-
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 OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
- Returns:
- The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
-
deletionProtectionEnabled
When set to true the pool can't be deleted.
- Returns:
- When set to true the pool can't be deleted.
-
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<UpdatePoolRequest.Builder,
UpdatePoolRequest> - Specified by:
toBuilder
in classPinpointSmsVoiceV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-