Class RcsAgentInformation

java.lang.Object
software.amazon.awssdk.services.pinpointsmsvoicev2.model.RcsAgentInformation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RcsAgentInformation.Builder,RcsAgentInformation>
@Generated("software.amazon.awssdk:codegen") public final class RcsAgentInformation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RcsAgentInformation.Builder,RcsAgentInformation>

The information for an RCS agent in an Amazon Web Services account.

See Also:

  • Method Details

    • rcsAgentArn

      public final String rcsAgentArn()

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

      Returns:
      The Amazon Resource Name (ARN) of the 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:

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

    • deletionProtectionEnabled

      public final Boolean deletionProtectionEnabled()

      When set to true the RCS agent can't be deleted.

      Returns:
      When set to true the RCS agent can't be deleted.

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

    • selfManagedOptOutsEnabled

      public final Boolean selfManagedOptOutsEnabled()

      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:
      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()

      When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

      Returns:
      When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

    • poolId

      public final String poolId()

      The unique identifier of the pool associated with the RCS agent.

      Returns:
      The unique identifier of the pool associated with the RCS agent.

    • twoWayMediaS3BucketName

      public final String twoWayMediaS3BucketName()

      The name of the S3 bucket where inbound RCS media files are stored.

      Returns:
      The name of the S3 bucket where inbound RCS media files are stored.

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

      Returns:
      The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.

    • 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 enabled for two-way messaging on the 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 hasTwoWayRcsEventsEnabled() method.

      Returns:
      The list of RCS event types enabled for two-way messaging on the agent.

    • testingAgent

      public final TestingAgentInformation testingAgent()

      The testing agent information associated with the RCS agent.

      Returns:
      The testing agent information associated with the RCS agent.

    • toBuilder

      public RcsAgentInformation.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<RcsAgentInformation.Builder,RcsAgentInformation>
      Returns:
      a builder for type T

    • builder

      public static RcsAgentInformation.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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