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

Interface DescribeLedgerResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeLedgerResponse.Builder,DescribeLedgerResponse>, QldbResponse.Builder, SdkBuilder<DescribeLedgerResponse.Builder,DescribeLedgerResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeLedgerResponse

public static interface DescribeLedgerResponse.Builder
extends QldbResponse.Builder, SdkPojo, CopyableBuilder<DescribeLedgerResponse.Builder,DescribeLedgerResponse>

Method Summary

Modifier and Type	Method	Description
DescribeLedgerResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) for the ledger.
DescribeLedgerResponse.Builder	creationDateTime(Instant creationDateTime)	The date and time, in epoch time format, when the ledger was created.
DescribeLedgerResponse.Builder	deletionProtection(Boolean deletionProtection)	Specifies whether the ledger is protected from being deleted by any user.
default DescribeLedgerResponse.Builder	encryptionDescription(Consumer<LedgerEncryptionDescription.Builder> encryptionDescription)	Information about the encryption of data at rest in the ledger.
DescribeLedgerResponse.Builder	encryptionDescription(LedgerEncryptionDescription encryptionDescription)	Information about the encryption of data at rest in the ledger.
DescribeLedgerResponse.Builder	name(String name)	The name of the ledger.
DescribeLedgerResponse.Builder	permissionsMode(String permissionsMode)	The permissions mode of the ledger.
DescribeLedgerResponse.Builder	permissionsMode(PermissionsMode permissionsMode)	The permissions mode of the ledger.
DescribeLedgerResponse.Builder	state(String state)	The current status of the ledger.
DescribeLedgerResponse.Builder	state(LedgerState state)	The current status of the ledger.

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

copy

Methods inherited from interface software.amazon.awssdk.services.qldb.model.QldbResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

name

DescribeLedgerResponse.Builder name(String name)

The name of the ledger.

Parameters:

name - The name of the ledger.

Returns:

Returns a reference to this object so that method calls can be chained together.

arn

DescribeLedgerResponse.Builder arn(String arn)

The Amazon Resource Name (ARN) for the ledger.

Parameters:

arn - The Amazon Resource Name (ARN) for the ledger.

Returns:

Returns a reference to this object so that method calls can be chained together.

state

DescribeLedgerResponse.Builder state(String state)

The current status of the ledger.

Parameters:

state - The current status of the ledger.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LedgerState, LedgerState

state

DescribeLedgerResponse.Builder state(LedgerState state)

The current status of the ledger.

Parameters:

state - The current status of the ledger.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LedgerState, LedgerState

creationDateTime

DescribeLedgerResponse.Builder creationDateTime(Instant creationDateTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

permissionsMode

DescribeLedgerResponse.Builder permissionsMode(String permissionsMode)

The permissions mode of the ledger.

Parameters:

permissionsMode - The permissions mode of the ledger.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionsMode, PermissionsMode

permissionsMode

DescribeLedgerResponse.Builder permissionsMode(PermissionsMode permissionsMode)

The permissions mode of the ledger.

Parameters:

permissionsMode - The permissions mode of the ledger.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionsMode, PermissionsMode

deletionProtection

DescribeLedgerResponse.Builder deletionProtection(Boolean deletionProtection)

Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

Parameters:

deletionProtection - Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionDescription

DescribeLedgerResponse.Builder encryptionDescription(LedgerEncryptionDescription encryptionDescription)

Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

Parameters:

encryptionDescription - Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionDescription

default DescribeLedgerResponse.Builder encryptionDescription(Consumer<LedgerEncryptionDescription.Builder> encryptionDescription)

Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

This is a convenience method that creates an instance of the LedgerEncryptionDescription.Builder avoiding the need to create one manually via LedgerEncryptionDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionDescription(LedgerEncryptionDescription).

Parameters:

encryptionDescription - a consumer that will call methods on LedgerEncryptionDescription.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

encryptionDescription(LedgerEncryptionDescription)