ReplicaGlobalSecondaryIndexSettingsDescription (aws-android-sdk-ddb 2.68.0 API)

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

All Implemented Interfaces:

java.io.Serializable
```
public class ReplicaGlobalSecondaryIndexSettingsDescription
extends java.lang.Object
implements java.io.Serializable
```
Represents the properties of a global secondary index.

See Also:

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
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getIndexName()` The name of the global secondary index.
`java.lang.String`	`getIndexStatus()` The current status of the global secondary index:
`AutoScalingSettingsDescription`	`getProvisionedReadCapacityAutoScalingSettings()` Autoscaling settings for a global secondary index replica's read capacity units.
`java.lang.Long`	`getProvisionedReadCapacityUnits()` The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`.
`AutoScalingSettingsDescription`	`getProvisionedWriteCapacityAutoScalingSettings()` AutoScaling settings for a global secondary index replica's write capacity units.
`java.lang.Long`	`getProvisionedWriteCapacityUnits()` The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.
`int`	`hashCode()`
`void`	`setIndexName(java.lang.String indexName)` The name of the global secondary index.
`void`	`setIndexStatus(IndexStatus indexStatus)` The current status of the global secondary index:
`void`	`setIndexStatus(java.lang.String indexStatus)` The current status of the global secondary index:
`void`	`setProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings)` Autoscaling settings for a global secondary index replica's read capacity units.
`void`	`setProvisionedReadCapacityUnits(java.lang.Long provisionedReadCapacityUnits)` The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`.
`void`	`setProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings)` AutoScaling settings for a global secondary index replica's write capacity units.
`void`	`setProvisionedWriteCapacityUnits(java.lang.Long provisionedWriteCapacityUnits)` The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withIndexName(java.lang.String indexName)` The name of the global secondary index.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withIndexStatus(IndexStatus indexStatus)` The current status of the global secondary index:
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withIndexStatus(java.lang.String indexStatus)` The current status of the global secondary index:
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings)` Autoscaling settings for a global secondary index replica's read capacity units.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withProvisionedReadCapacityUnits(java.lang.Long provisionedReadCapacityUnits)` The maximum number of strongly consistent reads consumed per second before DynamoDB returns a `ThrottlingException`.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings)` AutoScaling settings for a global secondary index replica's write capacity units.
`ReplicaGlobalSecondaryIndexSettingsDescription`	`withProvisionedWriteCapacityUnits(java.lang.Long provisionedWriteCapacityUnits)` The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException`.

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

- Constructor Detail
  - ReplicaGlobalSecondaryIndexSettingsDescription
```
public ReplicaGlobalSecondaryIndexSettingsDescription()
```
- Method Detail
  - getIndexName
```
public java.lang.String getIndexName()
```
    The name of the global secondary index. The name must be unique among all other indexes on this table.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The name of the global secondary index. The name must be unique among all other indexes on this table.
  - setIndexName
```
public void setIndexName(java.lang.String indexName)
```
    The name of the global secondary index. The name must be unique among all other indexes on this table.
    
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    indexName -
    The name of the global secondary index. The name must be unique among all other indexes on this table.
  - withIndexName
```
public ReplicaGlobalSecondaryIndexSettingsDescription withIndexName(java.lang.String indexName)
```
    The name of the global secondary index. The name must be unique among all other indexes on this table.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    indexName -
    The name of the global secondary index. The name must be unique among all other indexes on this table.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIndexStatus
```
public java.lang.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.
    Constraints:
    Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
    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
  - setIndexStatus
```
public void setIndexStatus(java.lang.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.
    Constraints:
    Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
    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
  - withIndexStatus
```
public ReplicaGlobalSecondaryIndexSettingsDescription withIndexStatus(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - setIndexStatus
```
public void setIndexStatus(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.
    Constraints:
    Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
    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
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - getProvisionedReadCapacityUnits
```
public java.lang.Long getProvisionedReadCapacityUnits()
```
    The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
    
    Constraints:
    Range: 1 -
    
    Returns:
    
    The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException .
  - setProvisionedReadCapacityUnits
```
public void setProvisionedReadCapacityUnits(java.lang.Long provisionedReadCapacityUnits)
```
    The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
    
    Constraints:
    Range: 1 -
    
    Parameters:
    
    provisionedReadCapacityUnits -
    The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
  - withProvisionedReadCapacityUnits
```
public ReplicaGlobalSecondaryIndexSettingsDescription withProvisionedReadCapacityUnits(java.lang.Long provisionedReadCapacityUnits)
```
    The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 -
    
    Parameters:
    
    provisionedReadCapacityUnits -
    The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getProvisionedReadCapacityAutoScalingSettings
```
public AutoScalingSettingsDescription getProvisionedReadCapacityAutoScalingSettings()
```
    Autoscaling settings for a global secondary index replica's read capacity units.
    
    Returns:
    
    Autoscaling settings for a global secondary index replica's read capacity units.
  - setProvisionedReadCapacityAutoScalingSettings
```
public void setProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings)
```
    Autoscaling settings for a global secondary index replica's read capacity units.
    
    Parameters:
    
    provisionedReadCapacityAutoScalingSettings -
    Autoscaling settings for a global secondary index replica's read capacity units.
  - withProvisionedReadCapacityAutoScalingSettings
```
public ReplicaGlobalSecondaryIndexSettingsDescription withProvisionedReadCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings)
```
    Autoscaling settings for a global secondary index replica's read capacity units.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    provisionedReadCapacityAutoScalingSettings -
    Autoscaling settings for a global secondary index replica's read capacity units.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getProvisionedWriteCapacityUnits
```
public java.lang.Long getProvisionedWriteCapacityUnits()
```
    The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
    
    Constraints:
    Range: 1 -
    
    Returns:
    
    The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
  - setProvisionedWriteCapacityUnits
```
public void setProvisionedWriteCapacityUnits(java.lang.Long provisionedWriteCapacityUnits)
```
    The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
    
    Constraints:
    Range: 1 -
    
    Parameters:
    
    provisionedWriteCapacityUnits -
    The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
  - withProvisionedWriteCapacityUnits
```
public ReplicaGlobalSecondaryIndexSettingsDescription withProvisionedWriteCapacityUnits(java.lang.Long provisionedWriteCapacityUnits)
```
    The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 -
    
    Parameters:
    
    provisionedWriteCapacityUnits -
    The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getProvisionedWriteCapacityAutoScalingSettings
```
public AutoScalingSettingsDescription getProvisionedWriteCapacityAutoScalingSettings()
```
    AutoScaling settings for a global secondary index replica's write capacity units.
    
    Returns:
    
    AutoScaling settings for a global secondary index replica's write capacity units.
  - setProvisionedWriteCapacityAutoScalingSettings
```
public void setProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings)
```
    AutoScaling settings for a global secondary index replica's write capacity units.
    
    Parameters:
    
    provisionedWriteCapacityAutoScalingSettings -
    AutoScaling settings for a global secondary index replica's write capacity units.
  - withProvisionedWriteCapacityAutoScalingSettings
```
public ReplicaGlobalSecondaryIndexSettingsDescription withProvisionedWriteCapacityAutoScalingSettings(AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings)
```
    AutoScaling settings for a global secondary index replica's write capacity units.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    provisionedWriteCapacityAutoScalingSettings -
    AutoScaling settings for a global secondary index replica's write capacity units.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class ReplicaGlobalSecondaryIndexSettingsDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReplicaGlobalSecondaryIndexSettingsDescription

Method Detail

getIndexName

setIndexName

withIndexName

getIndexStatus

setIndexStatus

withIndexStatus

setIndexStatus

withIndexStatus

getProvisionedReadCapacityUnits

setProvisionedReadCapacityUnits

withProvisionedReadCapacityUnits

getProvisionedReadCapacityAutoScalingSettings

setProvisionedReadCapacityAutoScalingSettings

withProvisionedReadCapacityAutoScalingSettings

getProvisionedWriteCapacityUnits

setProvisionedWriteCapacityUnits

withProvisionedWriteCapacityUnits

getProvisionedWriteCapacityAutoScalingSettings

setProvisionedWriteCapacityAutoScalingSettings

withProvisionedWriteCapacityAutoScalingSettings

toString

hashCode

equals