Class UpdateGlobalTableSettingsRequest

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

  • Method Details

    • globalTableName

      public final String globalTableName()

      The name of the global table

      Returns:
      The name of the global table

    • globalTableBillingMode

      public final BillingMode globalTableBillingMode()

      The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

      • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

      • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

      If the service returns an enum value that is not available in the current SDK version, globalTableBillingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from globalTableBillingModeAsString().

      Returns:
      The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

      • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

      • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

      See Also:

    • globalTableBillingModeAsString

      public final String globalTableBillingModeAsString()

      The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

      • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

      • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

      If the service returns an enum value that is not available in the current SDK version, globalTableBillingMode will return BillingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from globalTableBillingModeAsString().

      Returns:
      The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

      • PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.

      • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

      See Also:

    • globalTableProvisionedWriteCapacityUnits

      public final Long globalTableProvisionedWriteCapacityUnits()

      The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

      Returns:
      The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

    • globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate

      public final AutoScalingSettingsUpdate globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate()

      Auto scaling settings for managing provisioned write capacity for the global table.

      Returns:
      Auto scaling settings for managing provisioned write capacity for the global table.

    • hasGlobalTableGlobalSecondaryIndexSettingsUpdate

      public final boolean hasGlobalTableGlobalSecondaryIndexSettingsUpdate()
      For responses, this returns true if the service returned a value for the GlobalTableGlobalSecondaryIndexSettingsUpdate 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.

    • globalTableGlobalSecondaryIndexSettingsUpdate

      public final List<GlobalTableGlobalSecondaryIndexSettingsUpdate> globalTableGlobalSecondaryIndexSettingsUpdate()

      Represents the settings of a global secondary index for a global table that will be modified.

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

      Returns:
      Represents the settings of a global secondary index for a global table that will be modified.

    • hasReplicaSettingsUpdate

      public final boolean hasReplicaSettingsUpdate()
      For responses, this returns true if the service returned a value for the ReplicaSettingsUpdate 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.

    • replicaSettingsUpdate

      public final List<ReplicaSettingsUpdate> replicaSettingsUpdate()

      Represents the settings for a global table in a Region that will be modified.

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

      Returns:
      Represents the settings for a global table in a Region that will be modified.

    • toBuilder

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

    • builder

      public static UpdateGlobalTableSettingsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateGlobalTableSettingsRequest.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.