Class ExportSummary

java.lang.Object
software.amazon.awssdk.services.simpledbv2.model.ExportSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExportSummary.Builder,ExportSummary>

@Generated("software.amazon.awssdk:codegen") public final class ExportSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExportSummary.Builder,ExportSummary>

Summary information about an export, including its unique identifier, current status, creation time, and the domain being exported.

See Also:
  • Method Details

    • exportArn

      public final String exportArn()

      Unique ARN identifier of the export.

      Returns:
      Unique ARN identifier of the export.
    • exportStatus

      public final ExportStatus exportStatus()

      The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.

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

      Returns:
      The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.
      See Also:
    • exportStatusAsString

      public final String exportStatusAsString()

      The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.

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

      Returns:
      The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.
      See Also:
    • requestedAt

      public final Instant requestedAt()

      Timestamp when the export request was received by the service

      Returns:
      Timestamp when the export request was received by the service
    • domainName

      public final String domainName()

      The name of the domain for which the export was created.

      Returns:
      The name of the domain for which the export was created.
    • toBuilder

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

      public static ExportSummary.Builder builder()
    • serializableBuilderClass

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