Class SendChannelMessageRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.chimesdkmessaging.model.ChimeSdkMessagingRequest
software.amazon.awssdk.services.chimesdkmessaging.model.SendChannelMessageRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SendChannelMessageRequest.Builder,SendChannelMessageRequest>
@Generated("software.amazon.awssdk:codegen") public final class SendChannelMessageRequest extends ChimeSdkMessagingRequest 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 channel message.

      Returns:
      The content of the channel message.

    • type

      public final ChannelMessageType type()

      The type of message, STANDARD or CONTROL.

      STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

      CONTROL messages are limited to 30 bytes and do not contain metadata.

      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.

      STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

      CONTROL messages are limited to 30 bytes and do not contain metadata.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of message, STANDARD or CONTROL.

      STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

      CONTROL messages are limited to 30 bytes and do not contain metadata.

      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.

      STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

      CONTROL messages are limited to 30 bytes and do not contain metadata.

      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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

      Returns:
      The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

    • pushNotification

      public final PushNotificationConfiguration pushNotification()

      The push notification configuration of the message.

      Returns:
      The push notification configuration of the message.

    • hasMessageAttributes

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

    • messageAttributes

      public final Map<String,MessageAttributeValue> messageAttributes()

      The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

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

      Returns:
      The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.

    • subChannelId

      public final String subChannelId()

      The ID of the SubChannel in the request.

      Returns:
      The ID of the SubChannel in the request.

    • contentType

      public final String contentType()

      The content type of the channel message.

      Returns:
      The content type of the channel message.

    • hasTarget

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

    • target

      public final List<Target> target()

      The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

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

      Returns:
      The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

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

    • sdkFieldNameToField

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