@Generated(value="software.amazon.awssdk:codegen") public final class ReplicaGlobalSecondaryIndexSettingsDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReplicaGlobalSecondaryIndexSettingsDescription.Builder,ReplicaGlobalSecondaryIndexSettingsDescription>
Represents the properties of a global secondary index.
Modifier and Type | Class and Description |
---|---|
static interface |
ReplicaGlobalSecondaryIndexSettingsDescription.Builder |
Modifier and Type | Method and Description |
---|---|
static ReplicaGlobalSecondaryIndexSettingsDescription.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
indexName()
The name of the global secondary index.
|
IndexStatus |
indexStatus()
The current status of the global secondary index:
|
String |
indexStatusAsString()
The current status of the global secondary index:
|
AutoScalingSettingsDescription |
provisionedReadCapacityAutoScalingSettings()
Autoscaling settings for a global secondary index replica's read capacity units.
|
Long |
provisionedReadCapacityUnits()
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException . |
AutoScalingSettingsDescription |
provisionedWriteCapacityAutoScalingSettings()
AutoScaling settings for a global secondary index replica's write capacity units.
|
Long |
provisionedWriteCapacityUnits()
The maximum number of writes consumed per second before DynamoDB returns a
ThrottlingException . |
List<SdkField<?>> |
sdkFields() |
static Class<? extends ReplicaGlobalSecondaryIndexSettingsDescription.Builder> |
serializableBuilderClass() |
ReplicaGlobalSecondaryIndexSettingsDescription.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String indexName()
The name of the global secondary index. The name must be unique among all other indexes on this table.
public IndexStatus 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
return IndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
indexStatusAsString()
.
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.
IndexStatus
public String 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
return IndexStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
indexStatusAsString()
.
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.
IndexStatus
public Long provisionedReadCapacityUnits()
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
ThrottlingException
.
ThrottlingException
.public AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings()
Autoscaling settings for a global secondary index replica's read capacity units.
public Long provisionedWriteCapacityUnits()
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException
.
ThrottlingException
.public AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings()
AutoScaling settings for a global secondary index replica's write capacity units.
public ReplicaGlobalSecondaryIndexSettingsDescription.Builder toBuilder()
public static ReplicaGlobalSecondaryIndexSettingsDescription.Builder builder()
public static Class<? extends ReplicaGlobalSecondaryIndexSettingsDescription.Builder> serializableBuilderClass()
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
Copyright © 2019. All rights reserved.