@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateTableRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateTableRequest() |
Modifier and Type | Method and Description |
---|---|
CreateTableRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
CapacitySpecification |
getCapacitySpecification()
Specifies the read/write throughput capacity mode for the table.
|
Comment |
getComment()
This parameter allows to enter a description of the table.
|
Integer |
getDefaultTimeToLive()
The default Time to Live setting in seconds for the table.
|
EncryptionSpecification |
getEncryptionSpecification()
Specifies how the encryption key for encryption at rest is managed for the table.
|
String |
getKeyspaceName()
The name of the keyspace that the table is going to be created in.
|
PointInTimeRecovery |
getPointInTimeRecovery()
Specifies if
pointInTimeRecovery is enabled or disabled for the table. |
SchemaDefinition |
getSchemaDefinition()
The
schemaDefinition consists of the following parameters. |
String |
getTableName()
The name of the table.
|
List<Tag> |
getTags()
A list of key-value pair tags to be attached to the resource.
|
TimeToLive |
getTtl()
Enables Time to Live custom settings for the table.
|
int |
hashCode() |
void |
setCapacitySpecification(CapacitySpecification capacitySpecification)
Specifies the read/write throughput capacity mode for the table.
|
void |
setComment(Comment comment)
This parameter allows to enter a description of the table.
|
void |
setDefaultTimeToLive(Integer defaultTimeToLive)
The default Time to Live setting in seconds for the table.
|
void |
setEncryptionSpecification(EncryptionSpecification encryptionSpecification)
Specifies how the encryption key for encryption at rest is managed for the table.
|
void |
setKeyspaceName(String keyspaceName)
The name of the keyspace that the table is going to be created in.
|
void |
setPointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery)
Specifies if
pointInTimeRecovery is enabled or disabled for the table. |
void |
setSchemaDefinition(SchemaDefinition schemaDefinition)
The
schemaDefinition consists of the following parameters. |
void |
setTableName(String tableName)
The name of the table.
|
void |
setTags(Collection<Tag> tags)
A list of key-value pair tags to be attached to the resource.
|
void |
setTtl(TimeToLive ttl)
Enables Time to Live custom settings for the table.
|
String |
toString()
Returns a string representation of this object.
|
CreateTableRequest |
withCapacitySpecification(CapacitySpecification capacitySpecification)
Specifies the read/write throughput capacity mode for the table.
|
CreateTableRequest |
withComment(Comment comment)
This parameter allows to enter a description of the table.
|
CreateTableRequest |
withDefaultTimeToLive(Integer defaultTimeToLive)
The default Time to Live setting in seconds for the table.
|
CreateTableRequest |
withEncryptionSpecification(EncryptionSpecification encryptionSpecification)
Specifies how the encryption key for encryption at rest is managed for the table.
|
CreateTableRequest |
withKeyspaceName(String keyspaceName)
The name of the keyspace that the table is going to be created in.
|
CreateTableRequest |
withPointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery)
Specifies if
pointInTimeRecovery is enabled or disabled for the table. |
CreateTableRequest |
withSchemaDefinition(SchemaDefinition schemaDefinition)
The
schemaDefinition consists of the following parameters. |
CreateTableRequest |
withTableName(String tableName)
The name of the table.
|
CreateTableRequest |
withTags(Collection<Tag> tags)
A list of key-value pair tags to be attached to the resource.
|
CreateTableRequest |
withTags(Tag... tags)
A list of key-value pair tags to be attached to the resource.
|
CreateTableRequest |
withTtl(TimeToLive ttl)
Enables Time to Live custom settings for the table.
|
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
public void setKeyspaceName(String keyspaceName)
The name of the keyspace that the table is going to be created in.
keyspaceName
- The name of the keyspace that the table is going to be created in.public String getKeyspaceName()
The name of the keyspace that the table is going to be created in.
public CreateTableRequest withKeyspaceName(String keyspaceName)
The name of the keyspace that the table is going to be created in.
keyspaceName
- The name of the keyspace that the table is going to be created in.public void setTableName(String tableName)
The name of the table.
tableName
- The name of the table.public String getTableName()
The name of the table.
public CreateTableRequest withTableName(String tableName)
The name of the table.
tableName
- The name of the table.public void setSchemaDefinition(SchemaDefinition schemaDefinition)
The schemaDefinition
consists of the following parameters.
For each column to be created:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type. For more information, see Data types in
the Amazon Keyspaces Developer Guide.
The primary key of the table consists of the following columns:
• partitionKeys
- The partition key can be a single column, or it can be a compound value composed
of two or more columns. The partition key portion of the primary key is required and determines how Amazon
Keyspaces stores your data.
• name
- The name of each partition key column.
• clusteringKeys
- The optional clustering column portion of your primary key determines how the
data is clustered and sorted within each partition.
• name
- The name of the clustering column.
• orderBy
- Sets the ascendant (ASC
) or descendant (DESC
) order modifier.
To define a column as static use staticColumns
- Static columns store values that are shared by all
rows in the same partition:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type.
schemaDefinition
- The schemaDefinition
consists of the following parameters.
For each column to be created:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type. For more information, see Data
types in the Amazon Keyspaces Developer Guide.
The primary key of the table consists of the following columns:
• partitionKeys
- The partition key can be a single column, or it can be a compound value
composed of two or more columns. The partition key portion of the primary key is required and determines
how Amazon Keyspaces stores your data.
• name
- The name of each partition key column.
• clusteringKeys
- The optional clustering column portion of your primary key determines how
the data is clustered and sorted within each partition.
• name
- The name of the clustering column.
• orderBy
- Sets the ascendant (ASC
) or descendant (DESC
) order
modifier.
To define a column as static use staticColumns
- Static columns store values that are shared
by all rows in the same partition:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type.
public SchemaDefinition getSchemaDefinition()
The schemaDefinition
consists of the following parameters.
For each column to be created:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type. For more information, see Data types in
the Amazon Keyspaces Developer Guide.
The primary key of the table consists of the following columns:
• partitionKeys
- The partition key can be a single column, or it can be a compound value composed
of two or more columns. The partition key portion of the primary key is required and determines how Amazon
Keyspaces stores your data.
• name
- The name of each partition key column.
• clusteringKeys
- The optional clustering column portion of your primary key determines how the
data is clustered and sorted within each partition.
• name
- The name of the clustering column.
• orderBy
- Sets the ascendant (ASC
) or descendant (DESC
) order modifier.
To define a column as static use staticColumns
- Static columns store values that are shared by all
rows in the same partition:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type.
schemaDefinition
consists of the following parameters.
For each column to be created:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type. For more information, see Data
types in the Amazon Keyspaces Developer Guide.
The primary key of the table consists of the following columns:
• partitionKeys
- The partition key can be a single column, or it can be a compound value
composed of two or more columns. The partition key portion of the primary key is required and determines
how Amazon Keyspaces stores your data.
• name
- The name of each partition key column.
• clusteringKeys
- The optional clustering column portion of your primary key determines how
the data is clustered and sorted within each partition.
• name
- The name of the clustering column.
• orderBy
- Sets the ascendant (ASC
) or descendant (DESC
) order
modifier.
To define a column as static use staticColumns
- Static columns store values that are shared
by all rows in the same partition:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type.
public CreateTableRequest withSchemaDefinition(SchemaDefinition schemaDefinition)
The schemaDefinition
consists of the following parameters.
For each column to be created:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type. For more information, see Data types in
the Amazon Keyspaces Developer Guide.
The primary key of the table consists of the following columns:
• partitionKeys
- The partition key can be a single column, or it can be a compound value composed
of two or more columns. The partition key portion of the primary key is required and determines how Amazon
Keyspaces stores your data.
• name
- The name of each partition key column.
• clusteringKeys
- The optional clustering column portion of your primary key determines how the
data is clustered and sorted within each partition.
• name
- The name of the clustering column.
• orderBy
- Sets the ascendant (ASC
) or descendant (DESC
) order modifier.
To define a column as static use staticColumns
- Static columns store values that are shared by all
rows in the same partition:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type.
schemaDefinition
- The schemaDefinition
consists of the following parameters.
For each column to be created:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type. For more information, see Data
types in the Amazon Keyspaces Developer Guide.
The primary key of the table consists of the following columns:
• partitionKeys
- The partition key can be a single column, or it can be a compound value
composed of two or more columns. The partition key portion of the primary key is required and determines
how Amazon Keyspaces stores your data.
• name
- The name of each partition key column.
• clusteringKeys
- The optional clustering column portion of your primary key determines how
the data is clustered and sorted within each partition.
• name
- The name of the clustering column.
• orderBy
- Sets the ascendant (ASC
) or descendant (DESC
) order
modifier.
To define a column as static use staticColumns
- Static columns store values that are shared
by all rows in the same partition:
• name
- The name of the column.
• type
- An Amazon Keyspaces data type.
public void setComment(Comment comment)
This parameter allows to enter a description of the table.
comment
- This parameter allows to enter a description of the table.public Comment getComment()
This parameter allows to enter a description of the table.
public CreateTableRequest withComment(Comment comment)
This parameter allows to enter a description of the table.
comment
- This parameter allows to enter a description of the table.public void setCapacitySpecification(CapacitySpecification capacitySpecification)
Specifies the read/write throughput capacity mode for the table. The options are:
• throughputMode:PAY_PER_REQUEST
and
• throughputMode:PROVISIONED
- Provisioned capacity mode requires readCapacityUnits
and
writeCapacityUnits
as input.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
capacitySpecification
- Specifies the read/write throughput capacity mode for the table. The options are:
• throughputMode:PAY_PER_REQUEST
and
• throughputMode:PROVISIONED
- Provisioned capacity mode requires
readCapacityUnits
and writeCapacityUnits
as input.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
public CapacitySpecification getCapacitySpecification()
Specifies the read/write throughput capacity mode for the table. The options are:
• throughputMode:PAY_PER_REQUEST
and
• throughputMode:PROVISIONED
- Provisioned capacity mode requires readCapacityUnits
and
writeCapacityUnits
as input.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
• throughputMode:PAY_PER_REQUEST
and
• throughputMode:PROVISIONED
- Provisioned capacity mode requires
readCapacityUnits
and writeCapacityUnits
as input.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
public CreateTableRequest withCapacitySpecification(CapacitySpecification capacitySpecification)
Specifies the read/write throughput capacity mode for the table. The options are:
• throughputMode:PAY_PER_REQUEST
and
• throughputMode:PROVISIONED
- Provisioned capacity mode requires readCapacityUnits
and
writeCapacityUnits
as input.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
capacitySpecification
- Specifies the read/write throughput capacity mode for the table. The options are:
• throughputMode:PAY_PER_REQUEST
and
• throughputMode:PROVISIONED
- Provisioned capacity mode requires
readCapacityUnits
and writeCapacityUnits
as input.
The default is throughput_mode:PAY_PER_REQUEST
.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
public void setEncryptionSpecification(EncryptionSpecification encryptionSpecification)
Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):
• type:AWS_OWNED_KMS_KEY
- This key is owned by Amazon Keyspaces.
• type:CUSTOMER_MANAGED_KMS_KEY
- This key is stored in your account and is created, owned, and
managed by you. This option requires the kms_key_identifier
of the KMS key in Amazon Resource Name
(ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
encryptionSpecification
- Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of
the following KMS key (KMS key):
• type:AWS_OWNED_KMS_KEY
- This key is owned by Amazon Keyspaces.
• type:CUSTOMER_MANAGED_KMS_KEY
- This key is stored in your account and is created, owned,
and managed by you. This option requires the kms_key_identifier
of the KMS key in Amazon
Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
public EncryptionSpecification getEncryptionSpecification()
Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):
• type:AWS_OWNED_KMS_KEY
- This key is owned by Amazon Keyspaces.
• type:CUSTOMER_MANAGED_KMS_KEY
- This key is stored in your account and is created, owned, and
managed by you. This option requires the kms_key_identifier
of the KMS key in Amazon Resource Name
(ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
• type:AWS_OWNED_KMS_KEY
- This key is owned by Amazon Keyspaces.
• type:CUSTOMER_MANAGED_KMS_KEY
- This key is stored in your account and is created, owned,
and managed by you. This option requires the kms_key_identifier
of the KMS key in Amazon
Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
public CreateTableRequest withEncryptionSpecification(EncryptionSpecification encryptionSpecification)
Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of the following KMS key (KMS key):
• type:AWS_OWNED_KMS_KEY
- This key is owned by Amazon Keyspaces.
• type:CUSTOMER_MANAGED_KMS_KEY
- This key is stored in your account and is created, owned, and
managed by you. This option requires the kms_key_identifier
of the KMS key in Amazon Resource Name
(ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
encryptionSpecification
- Specifies how the encryption key for encryption at rest is managed for the table. You can choose one of
the following KMS key (KMS key):
• type:AWS_OWNED_KMS_KEY
- This key is owned by Amazon Keyspaces.
• type:CUSTOMER_MANAGED_KMS_KEY
- This key is stored in your account and is created, owned,
and managed by you. This option requires the kms_key_identifier
of the KMS key in Amazon
Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
public void setPointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery)
Specifies if pointInTimeRecovery
is enabled or disabled for the table. The options are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
pointInTimeRecovery
- Specifies if pointInTimeRecovery
is enabled or disabled for the table. The options are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
public PointInTimeRecovery getPointInTimeRecovery()
Specifies if pointInTimeRecovery
is enabled or disabled for the table. The options are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
pointInTimeRecovery
is enabled or disabled for the table. The options are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
public CreateTableRequest withPointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery)
Specifies if pointInTimeRecovery
is enabled or disabled for the table. The options are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
pointInTimeRecovery
- Specifies if pointInTimeRecovery
is enabled or disabled for the table. The options are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
public void setTtl(TimeToLive ttl)
Enables Time to Live custom settings for the table. The options are:
• status:enabled
• status:disabled
The default is status:disabled
. After ttl
is enabled, you can't disable it for the
table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
ttl
- Enables Time to Live custom settings for the table. The options are:
• status:enabled
• status:disabled
The default is status:disabled
. After ttl
is enabled, you can't disable it for
the table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
public TimeToLive getTtl()
Enables Time to Live custom settings for the table. The options are:
• status:enabled
• status:disabled
The default is status:disabled
. After ttl
is enabled, you can't disable it for the
table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
• status:enabled
• status:disabled
The default is status:disabled
. After ttl
is enabled, you can't disable it for
the table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
public CreateTableRequest withTtl(TimeToLive ttl)
Enables Time to Live custom settings for the table. The options are:
• status:enabled
• status:disabled
The default is status:disabled
. After ttl
is enabled, you can't disable it for the
table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
ttl
- Enables Time to Live custom settings for the table. The options are:
• status:enabled
• status:disabled
The default is status:disabled
. After ttl
is enabled, you can't disable it for
the table.
For more information, see Expiring data by using Amazon Keyspaces Time to Live (TTL) in the Amazon Keyspaces Developer Guide.
public void setDefaultTimeToLive(Integer defaultTimeToLive)
The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
defaultTimeToLive
- The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
public Integer getDefaultTimeToLive()
The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
public CreateTableRequest withDefaultTimeToLive(Integer defaultTimeToLive)
The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
defaultTimeToLive
- The default Time to Live setting in seconds for the table.
For more information, see Setting the default TTL value for a table in the Amazon Keyspaces Developer Guide.
public List<Tag> getTags()
A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
public void setTags(Collection<Tag> tags)
A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
tags
- A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
public CreateTableRequest withTags(Tag... tags)
A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
public CreateTableRequest withTags(Collection<Tag> tags)
A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
tags
- A list of key-value pair tags to be attached to the resource.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
public String toString()
toString
in class Object
Object.toString()
public CreateTableRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()