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("software.amazon.awssdk:codegen") public final class CreateLedgerResponse extends QldbResponse implements ToCopyableBuilder<CreateLedgerResponse.Builder,CreateLedgerResponse>

  • Method Details

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

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

    • permissionsMode

      public final PermissionsMode permissionsMode()

      The permissions mode of the ledger that you created.

      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 that you created.
      See Also:

    • permissionsModeAsString

      public final String permissionsModeAsString()

      The permissions mode of the ledger that you created.

      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 that you created.
      See Also:

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

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

      Returns:
      The ARN of the customer managed KMS key that the ledger uses for encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

    • toBuilder

      public CreateLedgerResponse.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<CreateLedgerResponse.Builder,CreateLedgerResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateLedgerResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateLedgerResponse.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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.