Interface DescribeLedgerResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeLedgerResponse.Builder,
,DescribeLedgerResponse> QldbResponse.Builder
,SdkBuilder<DescribeLedgerResponse.Builder,
,DescribeLedgerResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeLedgerResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) for the ledger.creationDateTime
(Instant creationDateTime) The date and time, in epoch time format, when the ledger was created.deletionProtection
(Boolean deletionProtection) Specifies whether the ledger is protected from being deleted by any user.default DescribeLedgerResponse.Builder
encryptionDescription
(Consumer<LedgerEncryptionDescription.Builder> encryptionDescription) Information about the encryption of data at rest in the ledger.encryptionDescription
(LedgerEncryptionDescription encryptionDescription) Information about the encryption of data at rest in the ledger.The name of the ledger.permissionsMode
(String permissionsMode) The permissions mode of the ledger.permissionsMode
(PermissionsMode permissionsMode) The permissions mode of the ledger.The current status of the ledger.state
(LedgerState state) The current status of the ledger.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.qldb.model.QldbResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
name
The name of the ledger.
- Parameters:
name
- The name of the ledger.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
The Amazon Resource Name (ARN) for the ledger.
- Parameters:
arn
- The Amazon Resource Name (ARN) for the ledger.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The current status of the ledger.
- Parameters:
state
- The current status of the ledger.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The current status of the ledger.
- Parameters:
state
- The current status of the ledger.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.)
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
permissionsMode
The permissions mode of the ledger.
- Parameters:
permissionsMode
- The permissions mode of the ledger.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
permissionsMode
The permissions mode of the ledger.
- Parameters:
permissionsMode
- The permissions mode of the ledger.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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
.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionDescription
DescribeLedgerResponse.Builder encryptionDescription(LedgerEncryptionDescription 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionDescription
default DescribeLedgerResponse.Builder encryptionDescription(Consumer<LedgerEncryptionDescription.Builder> 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.
This is a convenience method that creates an instance of theLedgerEncryptionDescription.Builder
avoiding the need to create one manually viaLedgerEncryptionDescription.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionDescription(LedgerEncryptionDescription)
.- Parameters:
encryptionDescription
- a consumer that will call methods onLedgerEncryptionDescription.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-