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>

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public PutKeywordRequest.Builder 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 interface ToCopyableBuilder<PutKeywordRequest.Builder,PutKeywordRequest>
      Specified by:
      toBuilder in class PinpointSmsVoiceV2Request
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.