Class Receipt

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

Records events during an engagement.

See Also:

  • Method Details

    • contactChannelArn

      public final String contactChannelArn()

      The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.

      Returns:
      The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.

    • receiptType

      public final ReceiptType receiptType()

      The type follows the engagement cycle, SENT, DELIVERED, and READ.

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

      Returns:
      The type follows the engagement cycle, SENT, DELIVERED, and READ.
      See Also:

    • receiptTypeAsString

      public final String receiptTypeAsString()

      The type follows the engagement cycle, SENT, DELIVERED, and READ.

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

      Returns:
      The type follows the engagement cycle, SENT, DELIVERED, and READ.
      See Also:

    • receiptInfo

      public final String receiptInfo()

      Information provided during the page acknowledgement.

      Returns:
      Information provided during the page acknowledgement.

    • receiptTime

      public final Instant receiptTime()

      The time receipt was SENT, DELIVERED, or READ.

      Returns:
      The time receipt was SENT, DELIVERED, or READ.

    • toBuilder

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

    • builder

      public static Receipt.Builder builder()

    • serializableBuilderClass

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