Class UpdateGlobalTableSettingsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateGlobalTableSettingsRequest.Builder,
UpdateGlobalTableSettingsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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 BillingMode
The billing mode of the global table.final String
The billing mode of the global table.Represents the settings of a global secondary index for a global table that will be modified.final String
The name of the global tableAuto scaling settings for managing provisioned write capacity for the global table.final Long
The maximum number of writes consumed per second before DynamoDB returns aThrottlingException.
final boolean
For responses, this returns true if the service returned a value for the GlobalTableGlobalSecondaryIndexSettingsUpdate property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ReplicaSettingsUpdate property.final List
<ReplicaSettingsUpdate> Represents the settings for a global table in a Region that will be modified.static Class
<? extends UpdateGlobalTableSettingsRequest.Builder> 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
-
globalTableName
The name of the global table
- Returns:
- The name of the global table
-
globalTableBillingMode
The billing mode of the global table. If
GlobalTableBillingMode
is not specified, the global table defaults toPROVISIONED
capacity billing mode.-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
If the service returns an enum value that is not available in the current SDK version,
globalTableBillingMode
will returnBillingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromglobalTableBillingModeAsString()
.- Returns:
- The billing mode of the global table. If
GlobalTableBillingMode
is not specified, the global table defaults toPROVISIONED
capacity billing mode.-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
-
- See Also:
-
-
globalTableBillingModeAsString
The billing mode of the global table. If
GlobalTableBillingMode
is not specified, the global table defaults toPROVISIONED
capacity billing mode.-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
If the service returns an enum value that is not available in the current SDK version,
globalTableBillingMode
will returnBillingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromglobalTableBillingModeAsString()
.- Returns:
- The billing mode of the global table. If
GlobalTableBillingMode
is not specified, the global table defaults toPROVISIONED
capacity billing mode.-
PROVISIONED
- We recommend usingPROVISIONED
for predictable workloads.PROVISIONED
sets the billing mode to Provisioned Mode. -
PAY_PER_REQUEST
- We recommend usingPAY_PER_REQUEST
for unpredictable workloads.PAY_PER_REQUEST
sets the billing mode to On-Demand Mode.
-
- See Also:
-
-
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 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. -
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 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. -
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
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<UpdateGlobalTableSettingsRequest.Builder,
UpdateGlobalTableSettingsRequest> - Specified by:
toBuilder
in classDynamoDbRequest
- 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
-