software.amazon.awssdk.services.qldb.model

Class CreateLedgerResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLedgerResponse.Builder,CreateLedgerResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLedgerResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) for the ledger.
static CreateLedgerResponse.Builder	builder()
Instant	creationDateTime() The date and time, in epoch time format, when the ledger was created.
Boolean	deletionProtection() The flag that prevents a ledger from being deleted by any user.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLedgerResponse.Builder>	serializableBuilderClass()
LedgerState	state() The current status of the ledger.
String	stateAsString() The current status of the ledger.
CreateLedgerResponse.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 String name()

The name of the ledger.

Returns:

The name of the ledger.

arn

public String arn()

The Amazon Resource Name (ARN) for the ledger.

Returns:

The Amazon Resource Name (ARN) for the ledger.

state

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

deletionProtection

public Boolean deletionProtection()

The flag that prevents a ledger from being deleted by any user. If not provided on 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 using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

Returns:

The flag that prevents a ledger from being deleted by any user. If not provided on 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 using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

toBuilder

public CreateLedgerResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLedgerResponse.Builder,CreateLedgerResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateLedgerResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo