com.amazonaws.services.dynamodbv2.model

Class LocalSecondaryIndex

java.lang.Object

com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndex

All Implemented Interfaces:

Serializable

public class LocalSecondaryIndex
extends Object
implements Serializable

Represents a local secondary index.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalSecondaryIndex()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getIndexName() Represents the name of the secondary index.
List<KeySchemaElement>	getKeySchema() Represents the complete index key schema, 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 the index.
int	hashCode()
void	setIndexName(String indexName) Represents the name of the secondary index.
void	setKeySchema(Collection<KeySchemaElement> keySchema) Represents the complete index key schema, 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 the index.
String	toString() Returns a string representation of this object; useful for testing and debugging.
LocalSecondaryIndex	withIndexName(String indexName) Represents the name of the secondary index.
LocalSecondaryIndex	withKeySchema(Collection<KeySchemaElement> keySchema) Represents the complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).
LocalSecondaryIndex	withKeySchema(KeySchemaElement... keySchema) Represents the complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).
LocalSecondaryIndex	withProjection(Projection projection) Represents attributes that are copied (projected) from the table into the index.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LocalSecondaryIndex

public LocalSecondaryIndex()

Method Detail

getIndexName

public String getIndexName()

Represents the name of the secondary index. The name must be unique among all other indexes on this table.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:

Represents the name of the secondary index. The name must be unique among all other indexes on this table.

setIndexName

public void setIndexName(String indexName)

Represents the name of the 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 - Represents the name of the secondary index. The name must be unique among all other indexes on this table.

withIndexName

public LocalSecondaryIndex withIndexName(String indexName)

Represents the name of the 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 - Represents the name of the 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()

Represents the complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

Constraints:
Length: 1 - 2

Returns:

Represents the complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

setKeySchema

public void setKeySchema(Collection<KeySchemaElement> keySchema)

Represents the complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

Constraints:
Length: 1 - 2

Parameters:

keySchema - Represents the complete index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

withKeySchema

public LocalSecondaryIndex withKeySchema(KeySchemaElement... keySchema)

Represents the complete index key schema, 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 - Represents the complete index key schema, 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 LocalSecondaryIndex withKeySchema(Collection<KeySchemaElement> keySchema)

Represents the complete index key schema, 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 - Represents the complete index key schema, 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 the 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 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 the 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 index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

withProjection

public LocalSecondaryIndex withProjection(Projection projection)

Represents attributes that are copied (projected) from the table into the 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 the 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.

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