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

Class LedgerSummary

java.lang.Object

software.amazon.awssdk.services.qldb.model.LedgerSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LedgerSummary.Builder,LedgerSummary>

@Generated("software.amazon.awssdk:codegen")
public final class LedgerSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LedgerSummary.Builder,LedgerSummary>

Information about a ledger, including its name, state, and when it was created.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LedgerSummary.Builder

Method Summary

Modifier and Type	Method	Description
static LedgerSummary.Builder	builder()
Instant	creationDateTime()	The date and time, in epoch time format, when the ledger was created.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends LedgerSummary.Builder>	serializableBuilderClass()
LedgerState	state()	The current status of the ledger.
String	stateAsString()	The current status of the ledger.
LedgerSummary.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

name

public final String name()

The name of the ledger.

Returns:

The name of 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.)

toBuilder

public LedgerSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LedgerSummary.Builder,LedgerSummary>

builder

public static LedgerSummary.Builder builder()

serializableBuilderClass

public static Class<? extends LedgerSummary.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo