Class GetExportResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.simpledbv2.model.SimpleDbV2Response
software.amazon.awssdk.services.simpledbv2.model.GetExportResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetExportResponse.Builder,GetExportResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetExportResponse extends SimpleDbV2Response implements ToCopyableBuilder<GetExportResponse.Builder,GetExportResponse>

  • Method Details

    • exportArn

      public final String exportArn()

      Unique ARN identifier of the export.

      Returns:
      Unique ARN identifier of the export.

    • clientToken

      public final String clientToken()

      The client token provided for this export.

      Returns:
      The client token provided for this 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:

    • domainName

      public final String domainName()

      The name of the domain that was exported.

      Returns:
      The name of the domain that was exported.

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

    • s3Bucket

      public final String s3Bucket()

      The name of the S3 bucket for this export.

      Returns:
      The name of the S3 bucket for this export.

    • s3KeyPrefix

      public final String s3KeyPrefix()

      The S3 key prefix provided in the corresponding StartDomainExport request.

      Returns:
      The S3 key prefix provided in the corresponding StartDomainExport request.

    • s3SseAlgorithm

      public final S3SseAlgorithm s3SseAlgorithm()

      The S3 SSE encryption algorithm for this export.

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

      Returns:
      The S3 SSE encryption algorithm for this export.
      See Also:

    • s3SseAlgorithmAsString

      public final String s3SseAlgorithmAsString()

      The S3 SSE encryption algorithm for this export.

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

      Returns:
      The S3 SSE encryption algorithm for this export.
      See Also:

    • s3SseKmsKeyId

      public final String s3SseKmsKeyId()

      The KMS key ID for this export.

      Returns:
      The KMS key ID for this export.

    • s3BucketOwner

      public final String s3BucketOwner()

      The S3 bucket owner account ID for this export.

      Returns:
      The S3 bucket owner account ID for this export.

    • failureCode

      public final String failureCode()

      Failure code for the result of the failed export.

      Returns:
      Failure code for the result of the failed export.

    • failureMessage

      public final String failureMessage()

      Export failure reason description.

      Returns:
      Export failure reason description.

    • exportManifest

      public final String exportManifest()

      The name of the manifest summary file for the export.

      Returns:
      The name of the manifest summary file for the export.

    • itemsCount

      public final Long itemsCount()

      Total number of exported items.

      Returns:
      Total number of exported items.

    • exportDataCutoffTime

      public final Instant exportDataCutoffTime()

      The timestamp indicating the cutoff point for data inclusion in the export. All data inserted or modified before this time will be present in the exported data. Data insertions or modifications after this timestamp may or may not be present in the export.

      Returns:
      The timestamp indicating the cutoff point for data inclusion in the export. All data inserted or modified before this time will be present in the exported data. Data insertions or modifications after this timestamp may or may not be present in the export.

    • toBuilder

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

    • builder

      public static GetExportResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetExportResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.