@Generated(value="software.amazon.awssdk:codegen") public final class CreateLedgerRequest extends QldbRequest implements ToCopyableBuilder<CreateLedgerRequest.Builder,CreateLedgerRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateLedgerRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateLedgerRequest.Builder |
builder() |
Boolean |
deletionProtection()
The flag that prevents a ledger from being deleted by any user.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
String |
name()
The name of the ledger that you want to create.
|
PermissionsMode |
permissionsMode()
The permissions mode to assign to the ledger that you want to create.
|
String |
permissionsModeAsString()
The permissions mode to assign to the ledger that you want to create.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateLedgerRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
tags()
The key-value pairs to add as tags to the ledger that you want to create.
|
CreateLedgerRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String name()
The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.
Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
Naming constraints for ledger names are defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide.
public final boolean hasTags()
public final Map<String,String> tags()
The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final PermissionsMode permissionsMode()
The permissions mode to assign to the ledger that you want to create.
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()
.
PermissionsMode
public final String permissionsModeAsString()
The permissions mode to assign to the ledger that you want to create.
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()
.
PermissionsMode
public final Boolean deletionProtection()
The flag that prevents a ledger from being deleted by any user. If not provided on 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 using the QLDB API
or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger
operation to set the flag to false
. The QLDB console disables deletion protection for you when you
use it to delete a ledger.
true
) by default.
If deletion protection is enabled, you must first disable it before you can delete the ledger using the
QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the
UpdateLedger
operation to set the flag to false
. The QLDB console disables
deletion protection for you when you use it to delete a ledger.
public CreateLedgerRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateLedgerRequest.Builder,CreateLedgerRequest>
toBuilder
in class QldbRequest
public static CreateLedgerRequest.Builder builder()
public static Class<? extends CreateLedgerRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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 SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.