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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JournalS3ExportDescription.Builder

Method Summary

Modifier and Type	Method	Description
static JournalS3ExportDescription.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	exclusiveEndTime()	The exclusive end date and time for the range of journal contents that was specified in the original export request.
Instant	exportCreationTime()	The date and time, in epoch time format, when the export job was created.
String	exportId()	The UUID (represented in Base62-encoded text) of the journal export job.
<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 that was specified in the original export request.
String	ledgerName()	The name of the ledger.
OutputFormat	outputFormat()	The output format of the exported journal data.
String	outputFormatAsString()	The output format of the 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()	Returns the value of the S3ExportConfiguration property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends JournalS3ExportDescription.Builder>	serializableBuilderClass()
ExportStatus	status()	The current state of the journal export job.
String	statusAsString()	The current state of the journal export job.
JournalS3ExportDescription.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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:

ExportStatus

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:

ExportStatus

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:

OutputFormat

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:

OutputFormat

toBuilder

public JournalS3ExportDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JournalS3ExportDescription.Builder,JournalS3ExportDescription>

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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo