com.amazonaws.services.qldb.model

Class CreateLedgerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.qldb.model.CreateLedgerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateLedgerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateLedgerRequest()

Method Summary

Modifier and Type	Method and Description
CreateLedgerRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateLedgerRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateLedgerRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getDeletionProtection() The flag that prevents a ledger from being deleted by any user.
String	getName() The name of the ledger that you want to create.
String	getPermissionsMode() The permissions mode to assign to the ledger that you want to create.
Map<String,String>	getTags() The key-value pairs to add as tags to the ledger that you want to create.
int	hashCode()
Boolean	isDeletionProtection() The flag that prevents a ledger from being deleted by any user.
void	setDeletionProtection(Boolean deletionProtection) The flag that prevents a ledger from being deleted by any user.
void	setName(String name) The name of the ledger that you want to create.
void	setPermissionsMode(String permissionsMode) The permissions mode to assign to the ledger that you want to create.
void	setTags(Map<String,String> tags) The key-value pairs to add as tags to the ledger that you want to create.
String	toString() Returns a string representation of this object.
CreateLedgerRequest	withDeletionProtection(Boolean deletionProtection) The flag that prevents a ledger from being deleted by any user.
CreateLedgerRequest	withName(String name) The name of the ledger that you want to create.
CreateLedgerRequest	withPermissionsMode(PermissionsMode permissionsMode) The permissions mode to assign to the ledger that you want to create.
CreateLedgerRequest	withPermissionsMode(String permissionsMode) The permissions mode to assign to the ledger that you want to create.
CreateLedgerRequest	withTags(Map<String,String> tags) The key-value pairs to add as tags to the ledger that you want to create.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateLedgerRequest

public CreateLedgerRequest()

Method Detail

setName

public void setName(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.

Parameters:

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.

getName

public String getName()

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.

withName

public CreateLedgerRequest withName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

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.

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.

setTags

public void setTags(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.

Parameters:

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.

withTags

public CreateLedgerRequest withTags(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateLedgerRequest addTagsEntry(String key,
                                        String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateLedgerRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPermissionsMode

public void setPermissionsMode(String permissionsMode)

The permissions mode to assign to the ledger that you want to create.

Parameters:

permissionsMode - The permissions mode to assign to the ledger that you want to create.

See Also:

PermissionsMode

getPermissionsMode

public String getPermissionsMode()

The permissions mode to assign to the ledger that you want to create.

Returns:

The permissions mode to assign to the ledger that you want to create.

See Also:

PermissionsMode

withPermissionsMode

public CreateLedgerRequest withPermissionsMode(String permissionsMode)

The permissions mode to assign to the ledger that you want to create.

Parameters:

permissionsMode - The permissions mode to assign to the ledger that you want to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionsMode

withPermissionsMode

public CreateLedgerRequest withPermissionsMode(PermissionsMode permissionsMode)

The permissions mode to assign to the ledger that you want to create.

Parameters:

permissionsMode - The permissions mode to assign to the ledger that you want to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionsMode

setDeletionProtection

public void setDeletionProtection(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.

Parameters:

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.

getDeletionProtection

public Boolean getDeletionProtection()

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.

withDeletionProtection

public CreateLedgerRequest withDeletionProtection(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isDeletionProtection

public Boolean isDeletionProtection()

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.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateLedgerRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()