Package software.amazon.awssdk.services.qldb.model

Class JournalS3ExportDescription

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

Information about a journal export job, including the ledger name, export ID, creation time, current status, and the parameters of the original export creation request.

See Also:

  • Method Details

    • ledgerName

      public final String ledgerName()

      The name of the ledger.

      Returns:
      The name of the ledger.

    • exportId

      public final String exportId()

      The UUID (represented in Base62-encoded text) of the journal export job.

      Returns:
      The UUID (represented in Base62-encoded text) of the journal export job.

    • exportCreationTime

      public final Instant exportCreationTime()

      The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

      Returns:
      The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    • status

      public final ExportStatus status()

      The current state of the journal export job.

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

      Returns:
      The current state of the journal export job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current state of the journal export job.

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

      Returns:
      The current state of the journal export job.
      See Also:

    • inclusiveStartTime

      public final Instant inclusiveStartTime()

      The inclusive start date and time for the range of journal contents that was specified in the original export request.

      Returns:
      The inclusive start date and time for the range of journal contents that was specified in the original export request.

    • exclusiveEndTime

      public final Instant exclusiveEndTime()

      The exclusive end date and time for the range of journal contents that was specified in the original export request.

      Returns:
      The exclusive end date and time for the range of journal contents that was specified in the original export request.

    • s3ExportConfiguration

      public final S3ExportConfiguration s3ExportConfiguration()
      Returns the value of the S3ExportConfiguration property for this object.
      Returns:
      The value of the S3ExportConfiguration property for this object.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

      • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

      • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

      • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

      • (Optional) Use your customer managed key in Key Management Service (KMS) for server-side encryption of your exported data.

    • outputFormat

      public final OutputFormat outputFormat()

      The output format of the exported journal data.

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

      Returns:
      The output format of the exported journal data.
      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      The output format of the exported journal data.

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

      Returns:
      The output format of the exported journal data.
      See Also:

    • toBuilder

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

    • builder

      public static JournalS3ExportDescription.Builder builder()

    • serializableBuilderClass

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