com.amazonaws.services.dynamodbv2.model

Class GlobalSecondaryIndexInfo

java.lang.Object

com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexInfo

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Represents the properties of a global secondary index for the table when the backup was created.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GlobalSecondaryIndexInfo()

Method Summary

Modifier and Type	Method and Description
GlobalSecondaryIndexInfo	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)
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.
GlobalSecondaryIndexInfo	withIndexName(String indexName) The name of the global secondary index.
GlobalSecondaryIndexInfo	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:
GlobalSecondaryIndexInfo	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:
GlobalSecondaryIndexInfo	withProjection(Projection projection) Represents attributes that are copied (projected) from the table into the global secondary index.
GlobalSecondaryIndexInfo	withProvisionedThroughput(ProvisionedThroughput provisionedThroughput) Represents the provisioned throughput settings for the specified global secondary index.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalSecondaryIndexInfo

public GlobalSecondaryIndexInfo()

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 GlobalSecondaryIndexInfo 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's 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's 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's 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's 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 GlobalSecondaryIndexInfo 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's 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's 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 GlobalSecondaryIndexInfo 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's 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's 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 GlobalSecondaryIndexInfo 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.

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary index.

getProvisionedThroughput

public ProvisionedThroughput getProvisionedThroughput()

Represents the provisioned throughput settings for the specified global secondary index.

Returns:

Represents the provisioned throughput settings for the specified global secondary index.

withProvisionedThroughput

public GlobalSecondaryIndexInfo withProvisionedThroughput(ProvisionedThroughput provisionedThroughput)

Represents the provisioned throughput settings for the specified global secondary index.

Parameters:

provisionedThroughput - Represents the provisioned throughput settings for the specified global secondary 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. 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 GlobalSecondaryIndexInfo clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo