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(value="software.amazon.awssdk:codegen")
public final class ExportJournalToS3Request
extends QldbRequest
implements ToCopyableBuilder<ExportJournalToS3Request.Builder,ExportJournalToS3Request>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExportJournalToS3Request.Builder

Method Summary

Modifier and Type	Method and Description
static ExportJournalToS3Request.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	exclusiveEndTime() The exclusive end date and time for the range of journal contents to export.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	inclusiveStartTime() The inclusive start date and time for the range of journal contents to export.
String	name() The name of the ledger.
OutputFormat	outputFormat() The output format of your exported journal data.
String	outputFormatAsString() The output format of your exported journal data.
String	roleArn() The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:
S3ExportConfiguration	s3ExportConfiguration() The configuration settings of the Amazon S3 bucket destination for your export request.
List<SdkField<?>>	sdkFields()
static Class<? extends ExportJournalToS3Request.Builder>	serializableBuilderClass()
ExportJournalToS3Request.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

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

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. If this parameter is not specified, the exported data defaults to ION_TEXT format.

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. If this parameter is not specified, the exported data defaults to ION_TEXT format.

See Also:

OutputFormat

outputFormatAsString

public final String outputFormatAsString()

The output format of your exported journal data. If this parameter is not specified, the exported data defaults to ION_TEXT format.

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. If this parameter is not specified, the exported data defaults to ION_TEXT format.

See Also:

OutputFormat

toBuilder

public ExportJournalToS3Request.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExportJournalToS3Request.Builder,ExportJournalToS3Request>

Specified by:

toBuilder in class QldbRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo