ReplicaGlobalSecondaryIndexSettingsDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dynamodbv2.model.ReplicaGlobalSecondaryIndexSettingsDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReplicaGlobalSecondaryIndexSettingsDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents the properties of a global secondary index.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ReplicaGlobalSecondaryIndexSettingsDescription()

Constructors
Constructor and Description
`ReplicaGlobalSecondaryIndexSettingsDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReplicaGlobalSecondaryIndexSettingsDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getIndexName()` The name of the global secondary index.
`String`	`getIndexStatus()` The current status of the global secondary index:
`AutoScalingSettingsDescription`	`getProvisionedReadCapacityAutoScalingSettings()` Auto scaling settings for a global secondary index replica's read capacity units.
`Long`	`getProvisionedReadCapacityUnits()` The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`.
`AutoScalingSettingsDescription`	`getProvisionedWriteCapacityAutoScalingSettings()` Auto scaling settings for a global secondary index replica's write capacity units.
`Long`	`getProvisionedWriteCapacityUnits()` The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setIndexName(String indexName)` The name of the global secondary index.
`void`	`setIndexStatus(String indexStatus)` The current status of the global secondary index:
`void`	`setProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings)` Auto scaling settings for a global secondary index replica's read capacity units.
`void`	`setProvisionedReadCapacityUnits(Long provisionedReadCapacityUnits)` The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`.
`void`	`setProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings)` Auto scaling settings for a global secondary index replica's write capacity units.
`void`	`setProvisionedWriteCapacityUnits(Long provisionedWriteCapacityUnits)` The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.
`String`	`toString()` Returns a string representation of this object.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withIndexName(String indexName)` The name of the global secondary index.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withIndexStatus(IndexStatus indexStatus)` The current status of the global secondary index:
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withIndexStatus(String indexStatus)` The current status of the global secondary index:
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings)` Auto scaling settings for a global secondary index replica's read capacity units.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withProvisionedReadCapacityUnits(Long provisionedReadCapacityUnits)` The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings)` Auto scaling settings for a global secondary index replica's write capacity units.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withProvisionedWriteCapacityUnits(Long provisionedWriteCapacityUnits)` The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ReplicaGlobalSecondaryIndexSettingsDescription
```
public ReplicaGlobalSecondaryIndexSettingsDescription()
```
- Method Detail
  - setIndexName
```
public void setIndexName(String indexName)
```
    The name of the global secondary index. The name must be unique among all other indexes on this table.
    
    Parameters:
    
    indexName - The name of the global secondary index. The name must be unique among all other indexes on this table.
  - getIndexName
```
public String getIndexName()
```
    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.
  - withIndexName
```
public ReplicaGlobalSecondaryIndexSettingsDescription withIndexName(String indexName)
```
    The name of the global secondary index. The name must be unique among all other indexes on this table.
    
    Parameters:
    
    indexName - The name of the global secondary index. The name must be unique among all other indexes on this table.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexStatus
```
public void setIndexStatus(String 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.
    Parameters:
    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.
    See Also:
    
    IndexStatus
  - getIndexStatus
```
public String getIndexStatus()
```
    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.
    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:
    
    IndexStatus
  - withIndexStatus
```
public ReplicaGlobalSecondaryIndexSettingsDescription withIndexStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - withIndexStatus
```
public ReplicaGlobalSecondaryIndexSettingsDescription withIndexStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - setProvisionedReadCapacityUnits
```
public void setProvisionedReadCapacityUnits(Long provisionedReadCapacityUnits)
```
    The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
    
    Parameters:
    
    provisionedReadCapacityUnits - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
  - getProvisionedReadCapacityUnits
```
public Long getProvisionedReadCapacityUnits()
```
    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.
  - withProvisionedReadCapacityUnits
```
public ReplicaGlobalSecondaryIndexSettingsDescription withProvisionedReadCapacityUnits(Long provisionedReadCapacityUnits)
```
    The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
    
    Parameters:
    
    provisionedReadCapacityUnits - The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProvisionedReadCapacityAutoScalingSettings
```
public void setProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings)
```
    Auto scaling settings for a global secondary index replica's read capacity units.
    
    Parameters:
    
    provisionedReadCapacityAutoScalingSettings - Auto scaling settings for a global secondary index replica's read capacity units.
  - getProvisionedReadCapacityAutoScalingSettings
```
public AutoScalingSettingsDescription getProvisionedReadCapacityAutoScalingSettings()
```
    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.
  - withProvisionedReadCapacityAutoScalingSettings
```
public ReplicaGlobalSecondaryIndexSettingsDescription withProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings)
```
    Auto scaling settings for a global secondary index replica's read capacity units.
    
    Parameters:
    
    provisionedReadCapacityAutoScalingSettings - Auto scaling settings for a global secondary index replica's read capacity units.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProvisionedWriteCapacityUnits
```
public void setProvisionedWriteCapacityUnits(Long provisionedWriteCapacityUnits)
```
    The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
    
    Parameters:
    
    provisionedWriteCapacityUnits - The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
  - getProvisionedWriteCapacityUnits
```
public Long getProvisionedWriteCapacityUnits()
```
    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.
  - withProvisionedWriteCapacityUnits
```
public ReplicaGlobalSecondaryIndexSettingsDescription withProvisionedWriteCapacityUnits(Long provisionedWriteCapacityUnits)
```
    The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
    
    Parameters:
    
    provisionedWriteCapacityUnits - The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProvisionedWriteCapacityAutoScalingSettings
```
public void setProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings)
```
    Auto scaling settings for a global secondary index replica's write capacity units.
    
    Parameters:
    
    provisionedWriteCapacityAutoScalingSettings - Auto scaling settings for a global secondary index replica's write capacity units.
  - getProvisionedWriteCapacityAutoScalingSettings
```
public AutoScalingSettingsDescription getProvisionedWriteCapacityAutoScalingSettings()
```
    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.
  - withProvisionedWriteCapacityAutoScalingSettings
```
public ReplicaGlobalSecondaryIndexSettingsDescription withProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings)
```
    Auto scaling settings for a global secondary index replica's write capacity units.
    
    Parameters:
    
    provisionedWriteCapacityAutoScalingSettings - Auto scaling settings for a global secondary index replica's write capacity units.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ReplicaGlobalSecondaryIndexSettingsDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ReplicaGlobalSecondaryIndexSettingsDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReplicaGlobalSecondaryIndexSettingsDescription

Method Detail

setIndexName

getIndexName

withIndexName

setIndexStatus

getIndexStatus

withIndexStatus

withIndexStatus

setProvisionedReadCapacityUnits

getProvisionedReadCapacityUnits

withProvisionedReadCapacityUnits

setProvisionedReadCapacityAutoScalingSettings

getProvisionedReadCapacityAutoScalingSettings

withProvisionedReadCapacityAutoScalingSettings

setProvisionedWriteCapacityUnits

getProvisionedWriteCapacityUnits

withProvisionedWriteCapacityUnits

setProvisionedWriteCapacityAutoScalingSettings

getProvisionedWriteCapacityAutoScalingSettings

withProvisionedWriteCapacityAutoScalingSettings

toString

equals

hashCode

clone

marshall