GlobalSecondaryIndex (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GlobalSecondaryIndex
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

GlobalSecondaryIndex()

Constructors
Constructor and Description
`GlobalSecondaryIndex()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GlobalSecondaryIndex`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getIndexName()` The name of the global secondary 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.
`ProvisionedThroughput`	`getProvisionedThroughput()` Represents the provisioned throughput settings for the specified global secondary index.
`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`	`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(ProvisionedThroughput 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.
`GlobalSecondaryIndex`	`withIndexName(String indexName)` The name of the global secondary index.
`GlobalSecondaryIndex`	`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:
`GlobalSecondaryIndex`	`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:
`GlobalSecondaryIndex`	`withProjection(Projection projection)` Represents attributes that are copied (projected) from the table into the global secondary index.
`GlobalSecondaryIndex`	`withProvisionedThroughput(ProvisionedThroughput 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
  - GlobalSecondaryIndex
```
public GlobalSecondaryIndex()
```
- 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 GlobalSecondaryIndex 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.
  - 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 GlobalSecondaryIndex 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 GlobalSecondaryIndex 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 GlobalSecondaryIndex 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.
  - setProvisionedThroughput
```
public void setProvisionedThroughput(ProvisionedThroughput 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 ProvisionedThroughput 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 GlobalSecondaryIndex withProvisionedThroughput(ProvisionedThroughput 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.
  - 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 GlobalSecondaryIndex 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 GlobalSecondaryIndex

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlobalSecondaryIndex

Method Detail

setIndexName

getIndexName

withIndexName

getKeySchema

setKeySchema

withKeySchema

withKeySchema

setProjection

getProjection

withProjection

setProvisionedThroughput

getProvisionedThroughput

withProvisionedThroughput

toString

equals

hashCode

clone

marshall