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

Class ExportJournalToS3Request

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.qldb.model.QldbRequest
software.amazon.awssdk.services.qldb.model.ExportJournalToS3Request
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ExportJournalToS3Request.Builder,ExportJournalToS3Request>
@Generated("software.amazon.awssdk:codegen") public final class ExportJournalToS3Request extends QldbRequest implements ToCopyableBuilder<ExportJournalToS3Request.Builder,ExportJournalToS3Request>

  • Method Details

    • name

      public final String name()

      The name of the ledger.

      Returns:
      The name of the ledger.

    • inclusiveStartTime

      public final Instant inclusiveStartTime()

      The inclusive start date and time for the range of journal contents to export.

      The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

      The InclusiveStartTime must be before ExclusiveEndTime.

      If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

      Returns:
      The inclusive start date and time for the range of journal contents to export.

      The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

      The InclusiveStartTime must be before ExclusiveEndTime.

      If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

    • exclusiveEndTime

      public final Instant exclusiveEndTime()

      The exclusive end date and time for the range of journal contents to export.

      The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

      The ExclusiveEndTime must be less than or equal to the current UTC date and time.

      Returns:
      The exclusive end date and time for the range of journal contents to export.

      The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z.

      The ExclusiveEndTime must be less than or equal to the current UTC date and time.

    • s3ExportConfiguration

      public final S3ExportConfiguration s3ExportConfiguration()

      The configuration settings of the Amazon S3 bucket destination for your export request.

      Returns:
      The configuration settings of the Amazon S3 bucket destination for your export request.

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

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

      To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.

      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 S3 bucket.

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

      To pass a role to QLDB when requesting a journal export, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal export requests.

    • outputFormat

      public final OutputFormat outputFormat()

      The output format of your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

      Default: ION_TEXT

      In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.

      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 your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

      Default: ION_TEXT

      In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.

      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      The output format of your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

      Default: ION_TEXT

      In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.

      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 your exported journal data. A journal export job can write the data objects in either the text or binary representation of Amazon Ion format, or in JSON Lines text format.

      Default: ION_TEXT

      In JSON Lines format, each journal block in an exported data object is a valid JSON object that is delimited by a newline. You can use this format to directly integrate JSON exports with analytics tools such as Amazon Athena and Glue because these services can parse newline-delimited JSON automatically.

      See Also:

    • toBuilder

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

    • builder

      public static ExportJournalToS3Request.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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