Class ReplicaGlobalSecondaryIndexSettingsDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,
ReplicaGlobalSecondaryIndexSettingsDescription>
Represents the properties of a global secondary index.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
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) final int
hashCode()
final String
The name of the global secondary index.final IndexStatus
The current status of the global secondary index:final String
The current status of the global secondary index:Auto scaling settings for a global secondary index replica's read capacity units.final Long
The maximum number of strongly consistent reads consumed per second before DynamoDB returns aThrottlingException
.Auto scaling settings for a global secondary index replica's write capacity units.final Long
The maximum number of writes consumed per second before DynamoDB returns aThrottlingException
.static Class
<? extends ReplicaGlobalSecondaryIndexSettingsDescription.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
indexName
The name of the global secondary index. The name must be unique among all other indexes on this table.
- Returns:
- The name of the global secondary index. The name must be unique among all other indexes on this table.
-
indexStatus
The current status of the global secondary index:
-
CREATING
- The global secondary index is being created. -
UPDATING
- The global secondary index is being updated. -
DELETING
- The global secondary index is being deleted. -
ACTIVE
- The global secondary index is ready for use.
If the service returns an enum value that is not available in the current SDK version,
indexStatus
will returnIndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexStatusAsString()
.- Returns:
- The current status of the global secondary index:
-
CREATING
- The global secondary index is being created. -
UPDATING
- The global secondary index is being updated. -
DELETING
- The global secondary index is being deleted. -
ACTIVE
- The global secondary index is ready for use.
-
- See Also:
-
-
indexStatusAsString
The current status of the global secondary index:
-
CREATING
- The global secondary index is being created. -
UPDATING
- The global secondary index is being updated. -
DELETING
- The global secondary index is being deleted. -
ACTIVE
- The global secondary index is ready for use.
If the service returns an enum value that is not available in the current SDK version,
indexStatus
will returnIndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromindexStatusAsString()
.- Returns:
- The current status of the global secondary index:
-
CREATING
- The global secondary index is being created. -
UPDATING
- The global secondary index is being updated. -
DELETING
- The global secondary index is being deleted. -
ACTIVE
- The global secondary index is ready for use.
-
- See Also:
-
-
provisionedReadCapacityUnits
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
.- Returns:
- The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
.
-
provisionedReadCapacityAutoScalingSettings
Auto scaling settings for a global secondary index replica's read capacity units.
- Returns:
- Auto scaling settings for a global secondary index replica's read capacity units.
-
provisionedWriteCapacityUnits
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
.
-
provisionedWriteCapacityAutoScalingSettings
Auto scaling settings for a global secondary index replica's write capacity units.
- Returns:
- Auto scaling settings for a global secondary index replica's write capacity units.
-
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<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,
ReplicaGlobalSecondaryIndexSettingsDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ReplicaGlobalSecondaryIndexSettingsDescription.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-