Class DescribeLedgerResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeLedgerResponse.Builder,
DescribeLedgerResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) for the ledger.builder()
final Instant
The date and time, in epoch time format, when the ledger was created.final Boolean
Specifies whether the ledger is protected from being deleted by any user.Information about the encryption of data at rest in the ledger.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
name()
The name of the ledger.final PermissionsMode
The permissions mode of the ledger.final String
The permissions mode of the ledger.static Class
<? extends DescribeLedgerResponse.Builder> final LedgerState
state()
The current status of the ledger.final String
The current status of the ledger.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the ledger.
- Returns:
- The name of the ledger.
-
arn
The Amazon Resource Name (ARN) for the ledger.
- Returns:
- The Amazon Resource Name (ARN) for the ledger.
-
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 returnLedgerState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current status of the ledger.
- See Also:
-
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 returnLedgerState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current status of the ledger.
- See Also:
-
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
The permissions mode of the ledger.
If the service returns an enum value that is not available in the current SDK version,
permissionsMode
will returnPermissionsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionsModeAsString()
.- Returns:
- The permissions mode of the ledger.
- See Also:
-
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 returnPermissionsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionsModeAsString()
.- Returns:
- The permissions mode of the ledger.
- See Also:
-
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 tofalse
.- 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 tofalse
.
-
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
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 interfaceToCopyableBuilder<DescribeLedgerResponse.Builder,
DescribeLedgerResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-