CreateLedgerRequest (AWS SDK for Java

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)` 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()`
`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.

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

Methods inherited from class java.lang.Object
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.
    
    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.
  - 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.
    
    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()
```
    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<CreateLedgerRequest.Builder,CreateLedgerRequest>
    
    Specified by:
    
    toBuilder in class QldbRequest
    
    Returns:
    
    a builder for type T
  - 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)
```
    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 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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 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.

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

tags

permissionsMode

permissionsModeAsString

deletionProtection

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields