CreateLedgerRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.qldb.model.QldbRequest
    - - software.amazon.awssdk.services.qldb.model.CreateLedgerRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateLedgerRequest.Builder,CreateLedgerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateLedgerRequest
extends QldbRequest
implements ToCopyableBuilder<CreateLedgerRequest.Builder,CreateLedgerRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateLedgerRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateLedgerRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public 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.
    
    Returns:
    
    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.
  - hasTags
```
public 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). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public 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.
    
    Returns:
    
    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.
  - permissionsMode
```
public 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().
    
    Returns:
    
    The permissions mode to assign to the ledger that you want to create.
    
    See Also:
    
    PermissionsMode
  - permissionsModeAsString
```
public 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().
    
    Returns:
    
    The permissions mode to assign to the ledger that you want to create.
    
    See Also:
    
    PermissionsMode
  - deletionProtection
```
public 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.
    
    Returns:
    
    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.
  - toBuilder
```
public CreateLedgerRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateLedgerRequest.Builder,CreateLedgerRequest>
    
    Specified by:
    
    toBuilder in class QldbRequest
  - builder
```
public static CreateLedgerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateLedgerRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateLedgerRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

hasTags

tags

permissionsMode

permissionsModeAsString

deletionProtection

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields