Class SendChannelMessageRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.chime.model.ChimeRequest
software.amazon.awssdk.services.chime.model.SendChannelMessageRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>
@Generated("software.amazon.awssdk:codegen") public final class SendChannelMessageRequest extends ChimeRequest implements ToCopyableBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>

  • Method Details

    • channelArn

      public final String channelArn()

      The ARN of the channel.

      Returns:
      The ARN of the channel.

    • content

      public final String content()

      The content of the message.

      Returns:
      The content of the message.

    • type

      public final ChannelMessageType type()

      The type of message, STANDARD or CONTROL.

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

      Returns:
      The type of message, STANDARD or CONTROL.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of message, STANDARD or CONTROL.

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

      Returns:
      The type of message, STANDARD or CONTROL.
      See Also:

    • persistence

      public final ChannelMessagePersistenceType persistence()

      Boolean that controls whether the message is persisted on the back end. Required.

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

      Returns:
      Boolean that controls whether the message is persisted on the back end. Required.
      See Also:

    • persistenceAsString

      public final String persistenceAsString()

      Boolean that controls whether the message is persisted on the back end. Required.

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

      Returns:
      Boolean that controls whether the message is persisted on the back end. Required.
      See Also:

    • metadata

      public final String metadata()

      The optional metadata for each message.

      Returns:
      The optional metadata for each message.

    • clientRequestToken

      public final String clientRequestToken()

      The Idempotency token for each client request.

      Returns:
      The Idempotency token for each client request.

    • chimeBearer

      public final String chimeBearer()

      The AppInstanceUserArn of the user that makes the API call.

      Returns:
      The AppInstanceUserArn of the user that makes the API call.

    • toBuilder

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

    • builder

      public static SendChannelMessageRequest.Builder builder()

    • serializableBuilderClass

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