Class UpdateRcsAgentRequest

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.UpdateRcsAgentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateRcsAgentRequest.Builder,UpdateRcsAgentRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateRcsAgentRequest extends PinpointSmsVoiceV2Request implements ToCopyableBuilder<UpdateRcsAgentRequest.Builder,UpdateRcsAgentRequest>

  • Method Details

    • rcsAgentId

      public final String rcsAgentId()

      The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.

      Returns:
      The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.

    • deletionProtectionEnabled

      public final Boolean deletionProtectionEnabled()

      By default this is set to false. When set to true the RCS agent can't be deleted.

      Returns:
      By default this is set to false. When set to true the RCS agent can't be deleted.

    • optOutListName

      public final String optOutListName()

      The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.

      Returns:
      The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.

    • selfManagedOptOutsEnabled

      public final Boolean selfManagedOptOutsEnabled()

      By default this is set to false. 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 set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

    • twoWayChannelArn

      public final String twoWayChannelArn()

      The Amazon Resource Name (ARN) of the two way channel.

      Returns:
      The Amazon Resource Name (ARN) of the two way channel.

    • twoWayChannelRole

      public final String 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.

    • twoWayEnabled

      public final Boolean 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.

    • twoWayMediaS3BucketName

      public final String twoWayMediaS3BucketName()

      The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3Role.

      Returns:
      The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3Role.

    • twoWayMediaS3KeyPrefix

      public final String twoWayMediaS3KeyPrefix()

      The key prefix used for inbound RCS media objects in the S3 bucket.

      Returns:
      The key prefix used for inbound RCS media objects in the S3 bucket.

    • twoWayMediaS3Role

      public final String twoWayMediaS3Role()

      The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3BucketName.

      Returns:
      The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3BucketName.

    • hasTwoWayRcsEventsEnabled

      public final boolean hasTwoWayRcsEventsEnabled()
      For responses, this returns true if the service returned a value for the TwoWayRcsEventsEnabled 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.

    • twoWayRcsEventsEnabled

      public final List<String> twoWayRcsEventsEnabled()

      The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used.

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

      Returns:
      The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used.

    • toBuilder

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

    • builder

      public static UpdateRcsAgentRequest.Builder builder()

    • serializableBuilderClass

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