@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateTableRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateTableRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateTableRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<ColumnDefinition> |
getAddColumns()
For each column to be added to the specified table:
|
AutoScalingSpecification |
getAutoScalingSpecification()
The optional auto scaling settings to update for a table in provisioned capacity mode.
|
CapacitySpecification |
getCapacitySpecification()
Modifies the read/write throughput capacity mode for the table.
|
ClientSideTimestamps |
getClientSideTimestamps()
Enables client-side timestamps for the table.
|
Integer |
getDefaultTimeToLive()
The default Time to Live setting in seconds for the table.
|
EncryptionSpecification |
getEncryptionSpecification()
Modifies the encryption settings of the table.
|
String |
getKeyspaceName()
The name of the keyspace the specified table is stored in.
|
PointInTimeRecovery |
getPointInTimeRecovery()
Modifies the
pointInTimeRecovery settings of the table. |
List<ReplicaSpecification> |
getReplicaSpecifications()
The Region specific settings of a multi-Regional table.
|
String |
getTableName()
The name of the table.
|
TimeToLive |
getTtl()
Modifies Time to Live custom settings for the table.
|
int |
hashCode() |
void |
setAddColumns(Collection<ColumnDefinition> addColumns)
For each column to be added to the specified table:
|
void |
setAutoScalingSpecification(AutoScalingSpecification autoScalingSpecification)
The optional auto scaling settings to update for a table in provisioned capacity mode.
|
void |
setCapacitySpecification(CapacitySpecification capacitySpecification)
Modifies the read/write throughput capacity mode for the table.
|
void |
setClientSideTimestamps(ClientSideTimestamps clientSideTimestamps)
Enables client-side timestamps for the table.
|
void |
setDefaultTimeToLive(Integer defaultTimeToLive)
The default Time to Live setting in seconds for the table.
|
void |
setEncryptionSpecification(EncryptionSpecification encryptionSpecification)
Modifies the encryption settings of the table.
|
void |
setKeyspaceName(String keyspaceName)
The name of the keyspace the specified table is stored in.
|
void |
setPointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery)
Modifies the
pointInTimeRecovery settings of the table. |
void |
setReplicaSpecifications(Collection<ReplicaSpecification> replicaSpecifications)
The Region specific settings of a multi-Regional table.
|
void |
setTableName(String tableName)
The name of the table.
|
void |
setTtl(TimeToLive ttl)
Modifies Time to Live custom settings for the table.
|
String |
toString()
Returns a string representation of this object.
|
UpdateTableRequest |
withAddColumns(Collection<ColumnDefinition> addColumns)
For each column to be added to the specified table:
|
UpdateTableRequest |
withAddColumns(ColumnDefinition... addColumns)
For each column to be added to the specified table:
|
UpdateTableRequest |
withAutoScalingSpecification(AutoScalingSpecification autoScalingSpecification)
The optional auto scaling settings to update for a table in provisioned capacity mode.
|
UpdateTableRequest |
withCapacitySpecification(CapacitySpecification capacitySpecification)
Modifies the read/write throughput capacity mode for the table.
|
UpdateTableRequest |
withClientSideTimestamps(ClientSideTimestamps clientSideTimestamps)
Enables client-side timestamps for the table.
|
UpdateTableRequest |
withDefaultTimeToLive(Integer defaultTimeToLive)
The default Time to Live setting in seconds for the table.
|
UpdateTableRequest |
withEncryptionSpecification(EncryptionSpecification encryptionSpecification)
Modifies the encryption settings of the table.
|
UpdateTableRequest |
withKeyspaceName(String keyspaceName)
The name of the keyspace the specified table is stored in.
|
UpdateTableRequest |
withPointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery)
Modifies the
pointInTimeRecovery settings of the table. |
UpdateTableRequest |
withReplicaSpecifications(Collection<ReplicaSpecification> replicaSpecifications)
The Region specific settings of a multi-Regional table.
|
UpdateTableRequest |
withReplicaSpecifications(ReplicaSpecification... replicaSpecifications)
The Region specific settings of a multi-Regional table.
|
UpdateTableRequest |
withTableName(String tableName)
The name of the table.
|
UpdateTableRequest |
withTtl(TimeToLive ttl)
Modifies 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 the specified table is stored in.
keyspaceName
- The name of the keyspace the specified table is stored in.public String getKeyspaceName()
The name of the keyspace the specified table is stored in.
public UpdateTableRequest withKeyspaceName(String keyspaceName)
The name of the keyspace the specified table is stored in.
keyspaceName
- The name of the keyspace the specified table is stored 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 UpdateTableRequest withTableName(String tableName)
The name of the table.
tableName
- The name of the table.public List<ColumnDefinition> getAddColumns()
For each column to be added to the specified table:
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data types in
the Amazon Keyspaces Developer Guide.
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data
types in the Amazon Keyspaces Developer Guide.
public void setAddColumns(Collection<ColumnDefinition> addColumns)
For each column to be added to the specified table:
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data types in
the Amazon Keyspaces Developer Guide.
addColumns
- For each column to be added to the specified table:
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data
types in the Amazon Keyspaces Developer Guide.
public UpdateTableRequest withAddColumns(ColumnDefinition... addColumns)
For each column to be added to the specified table:
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data types in
the Amazon Keyspaces Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setAddColumns(java.util.Collection)
or withAddColumns(java.util.Collection)
if you want to
override the existing values.
addColumns
- For each column to be added to the specified table:
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data
types in the Amazon Keyspaces Developer Guide.
public UpdateTableRequest withAddColumns(Collection<ColumnDefinition> addColumns)
For each column to be added to the specified table:
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data types in
the Amazon Keyspaces Developer Guide.
addColumns
- For each column to be added to the specified table:
name
- The name of the column.
type
- An Amazon Keyspaces data type. For more information, see Data
types in the Amazon Keyspaces Developer Guide.
public void setCapacitySpecification(CapacitySpecification capacitySpecification)
Modifies 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
- Modifies 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()
Modifies 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 UpdateTableRequest withCapacitySpecification(CapacitySpecification capacitySpecification)
Modifies 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
- Modifies 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)
Modifies the encryption settings of 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 AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
encryptionSpecification
- Modifies the encryption settings of 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 AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
public EncryptionSpecification getEncryptionSpecification()
Modifies the encryption settings of 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 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 AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
public UpdateTableRequest withEncryptionSpecification(EncryptionSpecification encryptionSpecification)
Modifies the encryption settings of 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 AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
encryptionSpecification
- Modifies the encryption settings of 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 AWS_OWNED_KMS_KEY
.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
public void setPointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery)
Modifies the pointInTimeRecovery
settings of the table. The options are:
status=ENABLED
status=DISABLED
If it's not specified, the default is status=DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
pointInTimeRecovery
- Modifies the pointInTimeRecovery
settings of the table. The options are:
status=ENABLED
status=DISABLED
If it's not specified, the default is status=DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
public PointInTimeRecovery getPointInTimeRecovery()
Modifies the pointInTimeRecovery
settings of the table. The options are:
status=ENABLED
status=DISABLED
If it's not specified, the default is status=DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
pointInTimeRecovery
settings of the table. The options are:
status=ENABLED
status=DISABLED
If it's not specified, the default is status=DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
public UpdateTableRequest withPointInTimeRecovery(PointInTimeRecovery pointInTimeRecovery)
Modifies the pointInTimeRecovery
settings of the table. The options are:
status=ENABLED
status=DISABLED
If it's not specified, the default is status=DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
pointInTimeRecovery
- Modifies the pointInTimeRecovery
settings of the table. The options are:
status=ENABLED
status=DISABLED
If it's not specified, the default is status=DISABLED
.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
public void setTtl(TimeToLive ttl)
Modifies 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
- Modifies 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()
Modifies 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 UpdateTableRequest withTtl(TimeToLive ttl)
Modifies 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
- Modifies 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 UpdateTableRequest 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 void setClientSideTimestamps(ClientSideTimestamps clientSideTimestamps)
Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:
status: "enabled"
Once client-side timestamps are enabled for a table, this setting cannot be disabled.
clientSideTimestamps
- Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
client-side timestamps with the following option:
status: "enabled"
Once client-side timestamps are enabled for a table, this setting cannot be disabled.
public ClientSideTimestamps getClientSideTimestamps()
Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:
status: "enabled"
Once client-side timestamps are enabled for a table, this setting cannot be disabled.
status: "enabled"
Once client-side timestamps are enabled for a table, this setting cannot be disabled.
public UpdateTableRequest withClientSideTimestamps(ClientSideTimestamps clientSideTimestamps)
Enables client-side timestamps for the table. By default, the setting is disabled. You can enable client-side timestamps with the following option:
status: "enabled"
Once client-side timestamps are enabled for a table, this setting cannot be disabled.
clientSideTimestamps
- Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
client-side timestamps with the following option:
status: "enabled"
Once client-side timestamps are enabled for a table, this setting cannot be disabled.
public void setAutoScalingSpecification(AutoScalingSpecification autoScalingSpecification)
The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.
If auto scaling is already enabled for the table, you can use UpdateTable
to update the minimum and
maximum values or the auto scaling policy settings independently.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
autoScalingSpecification
- The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the
service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon
Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by
increasing and decreasing your table's read and write capacity automatically in response to application
traffic.
If auto scaling is already enabled for the table, you can use UpdateTable
to update the
minimum and maximum values or the auto scaling policy settings independently.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
public AutoScalingSpecification getAutoScalingSpecification()
The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.
If auto scaling is already enabled for the table, you can use UpdateTable
to update the minimum and
maximum values or the auto scaling policy settings independently.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
If auto scaling is already enabled for the table, you can use UpdateTable
to update the
minimum and maximum values or the auto scaling policy settings independently.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
public UpdateTableRequest withAutoScalingSpecification(AutoScalingSpecification autoScalingSpecification)
The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.
If auto scaling is already enabled for the table, you can use UpdateTable
to update the minimum and
maximum values or the auto scaling policy settings independently.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
autoScalingSpecification
- The optional auto scaling settings to update for a table in provisioned capacity mode. Specifies if the
service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon
Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by
increasing and decreasing your table's read and write capacity automatically in response to application
traffic.
If auto scaling is already enabled for the table, you can use UpdateTable
to update the
minimum and maximum values or the auto scaling policy settings independently.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
public List<ReplicaSpecification> getReplicaSpecifications()
The Region specific settings of a multi-Regional table.
public void setReplicaSpecifications(Collection<ReplicaSpecification> replicaSpecifications)
The Region specific settings of a multi-Regional table.
replicaSpecifications
- The Region specific settings of a multi-Regional table.public UpdateTableRequest withReplicaSpecifications(ReplicaSpecification... replicaSpecifications)
The Region specific settings of a multi-Regional table.
NOTE: This method appends the values to the existing list (if any). Use
setReplicaSpecifications(java.util.Collection)
or
withReplicaSpecifications(java.util.Collection)
if you want to override the existing values.
replicaSpecifications
- The Region specific settings of a multi-Regional table.public UpdateTableRequest withReplicaSpecifications(Collection<ReplicaSpecification> replicaSpecifications)
The Region specific settings of a multi-Regional table.
replicaSpecifications
- The Region specific settings of a multi-Regional table.public String toString()
toString
in class Object
Object.toString()
public UpdateTableRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()