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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<LedgerSummary.Builder,LedgerSummary>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.