Package software.amazon.awssdk.services.connectparticipant.model

Class MessageMetadata

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

Contains metadata related to a message.

See Also:

  • Method Details

    • messageId

      public final String messageId()

      The identifier of the message that contains the metadata information.

      Returns:
      The identifier of the message that contains the metadata information.

    • hasReceipts

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

    • receipts

      public final List<Receipt> receipts()

      The list of receipt information for a message for different recipients.

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

      Returns:
      The list of receipt information for a message for different recipients.

    • messageProcessingStatus

      public final MessageProcessingStatus messageProcessingStatus()

      The status of Message Processing for the message.

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

      Returns:
      The status of Message Processing for the message.
      See Also:

    • messageProcessingStatusAsString

      public final String messageProcessingStatusAsString()

      The status of Message Processing for the message.

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

      Returns:
      The status of Message Processing for the message.
      See Also:

    • toBuilder

      public MessageMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<MessageMetadata.Builder,MessageMetadata>

    • builder

      public static MessageMetadata.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MessageMetadata.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo