Class RestoreTableRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RestoreTableRequest.Builder,
RestoreTableRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AutoScalingSpecification
The optional auto scaling settings for the restored table in provisioned capacity mode.static RestoreTableRequest.Builder
builder()
final CapacitySpecification
Specifies the read/write throughput capacity mode for the target table.final EncryptionSpecification
Specifies the encryption settings for the target table.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ReplicaSpecifications property.final boolean
For responses, this returns true if the service returned a value for the TagsOverride property.final PointInTimeRecovery
Specifies thepointInTimeRecovery
settings for the target table.final List
<ReplicaSpecification> The optional Region specific settings of a multi-Regional table.final Instant
The restore timestamp in ISO 8601 format.static Class
<? extends RestoreTableRequest.Builder> final String
The keyspace name of the source table.final String
The name of the source table.A list of key-value pair tags to be attached to the restored table.final String
The name of the target keyspace.final String
The name of the target table.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
sourceKeyspaceName
The keyspace name of the source table.
- Returns:
- The keyspace name of the source table.
-
sourceTableName
The name of the source table.
- Returns:
- The name of the source table.
-
targetKeyspaceName
The name of the target keyspace.
- Returns:
- The name of the target keyspace.
-
targetTableName
The name of the target table.
- Returns:
- The name of the target table.
-
restoreTimestamp
The restore timestamp in ISO 8601 format.
- Returns:
- The restore timestamp in ISO 8601 format.
-
capacitySpecificationOverride
Specifies the read/write throughput capacity mode for the target table. The options are:
-
throughputMode:PAY_PER_REQUEST
-
throughputMode:PROVISIONED
- Provisioned capacity mode requiresreadCapacityUnits
andwriteCapacityUnits
as input.
The default is
throughput_mode:PAY_PER_REQUEST
.For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
- Returns:
- Specifies the read/write throughput capacity mode for the target table. The options are:
-
throughputMode:PAY_PER_REQUEST
-
throughputMode:PROVISIONED
- Provisioned capacity mode requiresreadCapacityUnits
andwriteCapacityUnits
as input.
The default is
throughput_mode:PAY_PER_REQUEST
.For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
-
-
-
encryptionSpecificationOverride
Specifies the encryption settings for the target 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 thekms_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.
- Returns:
- Specifies the encryption settings for the target 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 thekms_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.
-
-
-
pointInTimeRecoveryOverride
Specifies the
pointInTimeRecovery
settings for the target 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.
- Returns:
- Specifies the
pointInTimeRecovery
settings for the target 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.
-
-
-
hasTagsOverride
public final boolean hasTagsOverride()For responses, this returns true if the service returned a value for the TagsOverride property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tagsOverride
A list of key-value pair tags to be attached to the restored table.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTagsOverride()
method.- Returns:
- A list of key-value pair tags to be attached to the restored table.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
-
autoScalingSpecification
The optional auto scaling settings for the restored 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.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
- Returns:
- The optional auto scaling settings for the restored 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.
For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
-
hasReplicaSpecifications
public final boolean hasReplicaSpecifications()For responses, this returns true if the service returned a value for the ReplicaSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
replicaSpecifications
The optional Region specific settings of a multi-Regional table.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasReplicaSpecifications()
method.- Returns:
- The optional Region specific settings of a multi-Regional table.
-
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 interfaceToCopyableBuilder<RestoreTableRequest.Builder,
RestoreTableRequest> - Specified by:
toBuilder
in classKeyspacesRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-