com.amazonaws.services.dynamodbv2.model

Class GlobalSecondaryIndex

java.lang.Object

com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndex

All Implemented Interfaces:

Serializable

public class GlobalSecondaryIndex
extends Object
implements Serializable

Represents a global secondary index.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GlobalSecondaryIndex()

Method Summary

Methods

Modifier and Type	Method and Description
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 (HASH or RANGE).
Projection	getProjection() Represents attributes that are copied (projected) from the table into an index.
ProvisionedThroughput	getProvisionedThroughput() Represents the provisioned throughput settings for a specified table or index.
int	hashCode()
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 (HASH or RANGE).
void	setProjection(Projection projection) Represents attributes that are copied (projected) from the table into an index.
void	setProvisionedThroughput(ProvisionedThroughput provisionedThroughput) Represents the provisioned throughput settings for a specified table or 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 (HASH or RANGE).
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 or RANGE).
GlobalSecondaryIndex	withProjection(Projection projection) Represents attributes that are copied (projected) from the table into an index.
GlobalSecondaryIndex	withProvisionedThroughput(ProvisionedThroughput provisionedThroughput) Represents the provisioned throughput settings for a specified table or index.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlobalSecondaryIndex

public GlobalSecondaryIndex()

Method Detail

getIndexName

public 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(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 GlobalSecondaryIndex withIndexName(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.

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 or RANGE).

Constraints:
Length: 1 - 2

Returns:

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

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 or RANGE).

Constraints:
Length: 1 - 2

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 or RANGE).

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 or RANGE).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

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 or RANGE).

Returns:

A reference to this updated 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 or RANGE).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

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 or RANGE).

Returns:

A reference to this updated object so that method calls can be chained together.

getProjection

public Projection getProjection()

Represents attributes that are copied (projected) from the table into an 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 an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

setProjection

public void setProjection(Projection projection)

Represents attributes that are copied (projected) from the table into an 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 an 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 an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Returns a reference to this object so that method calls can be chained together.

Parameters:

projection - Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Returns:

A reference to this updated object so that method calls can be chained together.

getProvisionedThroughput

public ProvisionedThroughput getProvisionedThroughput()

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Returns:

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

setProvisionedThroughput

public void setProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

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 a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Returns a reference to this object so that method calls can be chained together.

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object