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

Class DescribeLedgerResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.qldb.model.QldbResponse

software.amazon.awssdk.services.qldb.model.DescribeLedgerResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeLedgerResponse.Builder,DescribeLedgerResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeLedgerResponse
extends QldbResponse
implements ToCopyableBuilder<DescribeLedgerResponse.Builder,DescribeLedgerResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeLedgerResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) for the ledger.
static DescribeLedgerResponse.Builder	builder()
Instant	creationDateTime()	The date and time, in epoch time format, when the ledger was created.
Boolean	deletionProtection()	Specifies whether the ledger is protected from being deleted by any user.
LedgerEncryptionDescription	encryptionDescription()	Information about the encryption of data at rest in the ledger.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the ledger.
PermissionsMode	permissionsMode()	The permissions mode of the ledger.
String	permissionsModeAsString()	The permissions mode of the ledger.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeLedgerResponse.Builder>	serializableBuilderClass()
LedgerState	state()	The current status of the ledger.
String	stateAsString()	The current status of the ledger.
DescribeLedgerResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.qldb.model.QldbResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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.

arn

public final String arn()

The Amazon Resource Name (ARN) for the ledger.

Returns:

The Amazon Resource Name (ARN) for the ledger.

state

public final LedgerState state()

The current status of the ledger.

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

Returns:

The current status of the ledger.

See Also:

LedgerState

stateAsString

public final String stateAsString()

The current status of the ledger.

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

Returns:

The current status of the ledger.

See Also:

LedgerState

creationDateTime

public final 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.)

Returns:

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

permissionsMode

public final PermissionsMode permissionsMode()

The permissions mode of the ledger.

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

Returns:

The permissions mode of the ledger.

See Also:

PermissionsMode

permissionsModeAsString

public final String permissionsModeAsString()

The permissions mode of the ledger.

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

Returns:

The permissions mode of the ledger.

See Also:

PermissionsMode

deletionProtection

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

Returns:

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.

encryptionDescription

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

Returns:

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.

toBuilder

public DescribeLedgerResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeLedgerResponse.Builder,DescribeLedgerResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeLedgerResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo