GlobalSecondaryIndexDescription (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GlobalSecondaryIndexDescription
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

GlobalSecondaryIndexDescription()

Constructors
Constructor and Description
`GlobalSecondaryIndexDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GlobalSecondaryIndexDescription`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getBackfilling()` Indicates whether the index is currently backfilling.
`String`	`getIndexArn()` The Amazon Resource Name (ARN) that uniquely identifies the index.
`String`	`getIndexName()` The name of the global secondary index.
`Long`	`getIndexSizeBytes()` The total size of the specified index, in bytes.
`String`	`getIndexStatus()` The current state of the global secondary index:
`Long`	`getItemCount()` The number of items in the specified index.
`List<KeySchemaElement>`	`getKeySchema()` The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
`Projection`	`getProjection()` Represents attributes that are copied (projected) from the table into the global secondary index.
`ProvisionedThroughputDescription`	`getProvisionedThroughput()` Represents the provisioned throughput settings for the specified global secondary index.
`int`	`hashCode()`
`Boolean`	`isBackfilling()` Indicates whether the index is currently backfilling.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBackfilling(Boolean backfilling)` Indicates whether the index is currently backfilling.
`void`	`setIndexArn(String indexArn)` The Amazon Resource Name (ARN) that uniquely identifies the index.
`void`	`setIndexName(String indexName)` The name of the global secondary index.
`void`	`setIndexSizeBytes(Long indexSizeBytes)` The total size of the specified index, in bytes.
`void`	`setIndexStatus(IndexStatus indexStatus)` The current state of the global secondary index:
`void`	`setIndexStatus(String indexStatus)` The current state of the global secondary index:
`void`	`setItemCount(Long itemCount)` The number of items in the specified index.
`void`	`setKeySchema(Collection<KeySchemaElement> keySchema)` The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
`void`	`setProjection(Projection projection)` Represents attributes that are copied (projected) from the table into the global secondary index.
`void`	`setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)` Represents the provisioned throughput settings for the specified global secondary index.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GlobalSecondaryIndexDescription`	`withBackfilling(Boolean backfilling)` Indicates whether the index is currently backfilling.
`GlobalSecondaryIndexDescription`	`withIndexArn(String indexArn)` The Amazon Resource Name (ARN) that uniquely identifies the index.
`GlobalSecondaryIndexDescription`	`withIndexName(String indexName)` The name of the global secondary index.
`GlobalSecondaryIndexDescription`	`withIndexSizeBytes(Long indexSizeBytes)` The total size of the specified index, in bytes.
`GlobalSecondaryIndexDescription`	`withIndexStatus(IndexStatus indexStatus)` The current state of the global secondary index:
`GlobalSecondaryIndexDescription`	`withIndexStatus(String indexStatus)` The current state of the global secondary index:
`GlobalSecondaryIndexDescription`	`withItemCount(Long itemCount)` The number of items in the specified index.
`GlobalSecondaryIndexDescription`	`withKeySchema(Collection<KeySchemaElement> keySchema)` The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
`GlobalSecondaryIndexDescription`	`withKeySchema(KeySchemaElement... keySchema)` The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
`GlobalSecondaryIndexDescription`	`withProjection(Projection projection)` Represents attributes that are copied (projected) from the table into the global secondary index.
`GlobalSecondaryIndexDescription`	`withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)` Represents the provisioned throughput settings for the specified global secondary index.

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

- Constructor Detail
  - GlobalSecondaryIndexDescription
```
public GlobalSecondaryIndexDescription()
```
- Method Detail
  - setIndexName
```
public void setIndexName(String indexName)
```
    The name of the global secondary index.
    
    Parameters:
    
    indexName - The name of the global secondary index.
  - getIndexName
```
public String getIndexName()
```
    The name of the global secondary index.
    
    Returns:
    
    The name of the global secondary index.
  - withIndexName
```
public GlobalSecondaryIndexDescription withIndexName(String indexName)
```
    The name of the global secondary index.
    
    Parameters:
    
    indexName - The name of the global secondary index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getKeySchema
```
public List<KeySchemaElement> getKeySchema()
```
    The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    - HASH - partition key
    - RANGE - sort key
    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    Returns:
    The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    
    HASH - partition key
    
    RANGE - sort key
    
    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
  - setKeySchema
```
public void setKeySchema(Collection<KeySchemaElement> keySchema)
```
    The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    - HASH - partition key
    - RANGE - sort key
    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    Parameters:
    keySchema - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    
    HASH - partition key
    
    RANGE - sort key
    
    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
  - withKeySchema
```
public GlobalSecondaryIndexDescription withKeySchema(KeySchemaElement... keySchema)
```
    The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    - HASH - partition key
    - RANGE - sort key
    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    
    NOTE: This method appends the values to the existing list (if any). Use setKeySchema(java.util.Collection) or withKeySchema(java.util.Collection) if you want to override the existing values.
    Parameters:
    keySchema - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    
    HASH - partition key
    
    RANGE - sort key
    
    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withKeySchema
```
public GlobalSecondaryIndexDescription withKeySchema(Collection<KeySchemaElement> keySchema)
```
    The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    - HASH - partition key
    - RANGE - sort key
    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    Parameters:
    keySchema - The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
    
    HASH - partition key
    
    RANGE - sort key
    
    The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
    
    The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProjection
```
public void setProjection(Projection projection)
```
    Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
    
    Parameters:
    
    projection - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
  - getProjection
```
public Projection getProjection()
```
    Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
    
    Returns:
    
    Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
  - withProjection
```
public GlobalSecondaryIndexDescription withProjection(Projection projection)
```
    Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
    
    Parameters:
    
    projection - Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexStatus
```
public void setIndexStatus(String indexStatus)
```
    The current state of the global secondary index:
    - CREATING - The index is being created.
    - UPDATING - The index is being updated.
    - DELETING - The index is being deleted.
    - ACTIVE - The index is ready for use.
    Parameters:
    indexStatus - The current state of the global secondary index:
    
    CREATING - The index is being created.
    
    UPDATING - The index is being updated.
    
    DELETING - The index is being deleted.
    
    ACTIVE - The index is ready for use.
    See Also:
    
    IndexStatus
  - getIndexStatus
```
public String getIndexStatus()
```
    The current state of the global secondary index:
    - CREATING - The index is being created.
    - UPDATING - The index is being updated.
    - DELETING - The index is being deleted.
    - ACTIVE - The index is ready for use.
    Returns:
    The current state of the global secondary index:
    
    CREATING - The index is being created.
    
    UPDATING - The index is being updated.
    
    DELETING - The index is being deleted.
    
    ACTIVE - The index is ready for use.
    See Also:
    
    IndexStatus
  - withIndexStatus
```
public GlobalSecondaryIndexDescription withIndexStatus(String indexStatus)
```
    The current state of the global secondary index:
    - CREATING - The index is being created.
    - UPDATING - The index is being updated.
    - DELETING - The index is being deleted.
    - ACTIVE - The index is ready for use.
    Parameters:
    indexStatus - The current state of the global secondary index:
    
    CREATING - The index is being created.
    
    UPDATING - The index is being updated.
    
    DELETING - The index is being deleted.
    
    ACTIVE - The index is ready for use.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - setIndexStatus
```
public void setIndexStatus(IndexStatus indexStatus)
```
    The current state of the global secondary index:
    - CREATING - The index is being created.
    - UPDATING - The index is being updated.
    - DELETING - The index is being deleted.
    - ACTIVE - The index is ready for use.
    Parameters:
    indexStatus - The current state of the global secondary index:
    
    CREATING - The index is being created.
    
    UPDATING - The index is being updated.
    
    DELETING - The index is being deleted.
    
    ACTIVE - The index is ready for use.
    See Also:
    
    IndexStatus
  - withIndexStatus
```
public GlobalSecondaryIndexDescription withIndexStatus(IndexStatus indexStatus)
```
    The current state of the global secondary index:
    - CREATING - The index is being created.
    - UPDATING - The index is being updated.
    - DELETING - The index is being deleted.
    - ACTIVE - The index is ready for use.
    Parameters:
    indexStatus - The current state of the global secondary index:
    
    CREATING - The index is being created.
    
    UPDATING - The index is being updated.
    
    DELETING - The index is being deleted.
    
    ACTIVE - The index is ready for use.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - setBackfilling
```
public void setBackfilling(Boolean backfilling)
```
    Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
    
    For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
    
    Parameters:
    
    backfilling - Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
    
    For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
  - getBackfilling
```
public Boolean getBackfilling()
```
    Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
    
    For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
    
    Returns:
    
    Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
    
    For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
  - withBackfilling
```
public GlobalSecondaryIndexDescription withBackfilling(Boolean backfilling)
```
    Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
    
    For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
    
    Parameters:
    
    backfilling - Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
    
    For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isBackfilling
```
public Boolean isBackfilling()
```
    Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
    
    For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
    
    Returns:
    
    Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
    
    For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
  - setProvisionedThroughput
```
public void setProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
```
    Represents the provisioned throughput settings for the specified global secondary index.
    
    For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index.
    
    For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
  - getProvisionedThroughput
```
public ProvisionedThroughputDescription getProvisionedThroughput()
```
    Represents the provisioned throughput settings for the specified global secondary index.
    
    For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Represents the provisioned throughput settings for the specified global secondary index.
    
    For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
  - withProvisionedThroughput
```
public GlobalSecondaryIndexDescription withProvisionedThroughput(ProvisionedThroughputDescription provisionedThroughput)
```
    Represents the provisioned throughput settings for the specified global secondary index.
    
    For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index.
    
    For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexSizeBytes
```
public void setIndexSizeBytes(Long indexSizeBytes)
```
    The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Parameters:
    
    indexSizeBytes - The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  - getIndexSizeBytes
```
public Long getIndexSizeBytes()
```
    The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Returns:
    
    The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  - withIndexSizeBytes
```
public GlobalSecondaryIndexDescription withIndexSizeBytes(Long indexSizeBytes)
```
    The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Parameters:
    
    indexSizeBytes - The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setItemCount
```
public void setItemCount(Long itemCount)
```
    The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Parameters:
    
    itemCount - The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  - getItemCount
```
public Long getItemCount()
```
    The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Returns:
    
    The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
  - withItemCount
```
public GlobalSecondaryIndexDescription withItemCount(Long itemCount)
```
    The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Parameters:
    
    itemCount - The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexArn
```
public void setIndexArn(String indexArn)
```
    The Amazon Resource Name (ARN) that uniquely identifies the index.
    
    Parameters:
    
    indexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.
  - getIndexArn
```
public String getIndexArn()
```
    The Amazon Resource Name (ARN) that uniquely identifies the index.
    
    Returns:
    
    The Amazon Resource Name (ARN) that uniquely identifies the index.
  - withIndexArn
```
public GlobalSecondaryIndexDescription withIndexArn(String indexArn)
```
    The Amazon Resource Name (ARN) that uniquely identifies the index.
    
    Parameters:
    
    indexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.
    
    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; useful for testing and debugging.
    
    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 GlobalSecondaryIndexDescription 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 GlobalSecondaryIndexDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlobalSecondaryIndexDescription

Method Detail

setIndexName

getIndexName

withIndexName

getKeySchema

setKeySchema

withKeySchema

withKeySchema

setProjection

getProjection

withProjection

setIndexStatus

getIndexStatus

withIndexStatus

setIndexStatus

withIndexStatus

setBackfilling

getBackfilling

withBackfilling

isBackfilling

setProvisionedThroughput

getProvisionedThroughput

withProvisionedThroughput

setIndexSizeBytes

getIndexSizeBytes

withIndexSizeBytes

setItemCount

getItemCount

withItemCount

setIndexArn

getIndexArn

withIndexArn

toString

equals

hashCode

clone

marshall