Package software.amazon.awssdk.services.keyspaces.model

Class UpdateTableRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.keyspaces.model.KeyspacesRequest
software.amazon.awssdk.services.keyspaces.model.UpdateTableRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateTableRequest extends KeyspacesRequest implements ToCopyableBuilder<UpdateTableRequest.Builder,UpdateTableRequest>

  • Method Details

    • keyspaceName

      public final String keyspaceName()

      The name of the keyspace the specified table is stored in.

      Returns:
      The name of the keyspace the specified table is stored in.

    • tableName

      public final String tableName()

      The name of the table.

      Returns:
      The name of the table.

    • hasAddColumns

      public final boolean hasAddColumns()
      For responses, this returns true if the service returned a value for the AddColumns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • addColumns

      public final List<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.

      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 hasAddColumns() method.

      Returns:
      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.

    • capacitySpecification

      public final 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.

      Returns:
      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.

    • encryptionSpecification

      public final 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.

      Returns:
      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.

    • pointInTimeRecovery

      public final 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.

      Returns:
      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.

    • ttl

      public final 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.

      Returns:
      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.

    • defaultTimeToLive

      public final 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.

      Returns:
      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.

    • clientSideTimestamps

      public final 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.

      Returns:
      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.

    • autoScalingSpecification

      public final 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.

      Returns:
      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.

    • 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 the isEmpty() 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

      public final List<ReplicaSpecification> replicaSpecifications()

      The 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 Region specific settings of a multi-Regional table.

    • toBuilder

      public UpdateTableRequest.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<UpdateTableRequest.Builder,UpdateTableRequest>
      Specified by:
      toBuilder in class KeyspacesRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateTableRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateTableRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final 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 final 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 final <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 final 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.