Class CreateRcsAgentResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response
software.amazon.awssdk.services.pinpointsmsvoicev2.model.CreateRcsAgentResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRcsAgentResponse.Builder,CreateRcsAgentResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateRcsAgentResponse extends PinpointSmsVoiceV2Response implements ToCopyableBuilder<CreateRcsAgentResponse.Builder,CreateRcsAgentResponse>

  • Method Details

    • rcsAgentArn

      public final String rcsAgentArn()

      The Amazon Resource Name (ARN) of the newly created RCS agent.

      Returns:
      The Amazon Resource Name (ARN) of the newly created RCS agent.

    • rcsAgentId

      public final String rcsAgentId()

      The unique identifier for the RCS agent.

      Returns:
      The unique identifier for the RCS agent.

    • status

      public final RcsAgentStatus status()

      The current status of the RCS agent.

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

      Returns:
      The current status of the RCS agent.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the RCS agent.

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

      Returns:
      The current status of the RCS agent.
      See Also:

    • deletionProtectionEnabled

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

    • optOutListName

      public final String optOutListName()

      The name of the OptOutList associated with the RCS agent.

      Returns:
      The name of the OptOutList associated with the RCS agent.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time when the RCS agent was created, in UNIX epoch time format.

      Returns:
      The time when the RCS agent was created, in UNIX epoch time format.

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

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

    • tags

      public final List<Tag> tags()

      An array of tags (key and value pairs) associated with the RCS agent.

      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 RCS agent.

    • toBuilder

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

    • builder

      public static CreateRcsAgentResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateRcsAgentResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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