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

Class PutKeywordRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutKeywordRequest.Builder,PutKeywordRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutKeywordRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutKeywordRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyword()	The new keyword to add.
KeywordAction	keywordAction()	The action to perform for the new keyword when it is received.
String	keywordActionAsString()	The action to perform for the new keyword when it is received.
String	keywordMessage()	The message associated with the keyword.
String	originationIdentity()	The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutKeywordRequest.Builder>	serializableBuilderClass()
PutKeywordRequest.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 get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Returns:

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

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

keyword

public final String keyword()

The new keyword to add.

Returns:

The new keyword to add.

keywordMessage

public final String keywordMessage()

The message associated with the keyword.

Returns:

The message associated with the keyword.

keywordAction

public final KeywordAction keywordAction()

The action to perform for the new keyword when it is received.

• AUTOMATIC_RESPONSE: A message is sent to the recipient.

• OPT_OUT: Keeps the recipient from receiving future messages.

• OPT_IN: The recipient wants to receive future messages.

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

Returns:

The action to perform for the new keyword when it is received.

• AUTOMATIC_RESPONSE: A message is sent to the recipient.

• OPT_OUT: Keeps the recipient from receiving future messages.

• OPT_IN: The recipient wants to receive future messages.

See Also:

KeywordAction

keywordActionAsString

public final String keywordActionAsString()

The action to perform for the new keyword when it is received.

• AUTOMATIC_RESPONSE: A message is sent to the recipient.

• OPT_OUT: Keeps the recipient from receiving future messages.

• OPT_IN: The recipient wants to receive future messages.

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

Returns:

The action to perform for the new keyword when it is received.

• AUTOMATIC_RESPONSE: A message is sent to the recipient.

• OPT_OUT: Keeps the recipient from receiving future messages.

• OPT_IN: The recipient wants to receive future messages.

See Also:

KeywordAction

toBuilder

public PutKeywordRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutKeywordRequest.Builder,PutKeywordRequest>

Specified by:

toBuilder in class PinpointSmsVoiceV2Request

builder

public static PutKeywordRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo