com.amazonaws.services.dynamodbv2.model
Class LocalSecondaryIndexDescription

java.lang.Object
  com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription

All Implemented Interfaces:

Serializable

public class LocalSecondaryIndexDescription
extends Object
implements Serializable

Represents the properties of a secondary index.

See Also:

Serialized Form

Constructor Summary

LocalSecondaryIndexDescription()

Method Summary

boolean	equals(Object obj)
String	getIndexName() Represents the name of the secondary index.
Long	getIndexSizeBytes() Represents the total size of the index, in bytes.
Long	getItemCount() Represents the number of items in the 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	setIndexSizeBytes(Long indexSizeBytes) Represents the total size of the index, in bytes.
void	setItemCount(Long itemCount) Represents the number of items in the 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.
LocalSecondaryIndexDescription	withIndexName(String indexName) Represents the name of the secondary index.
LocalSecondaryIndexDescription	withIndexSizeBytes(Long indexSizeBytes) Represents the total size of the index, in bytes.
LocalSecondaryIndexDescription	withItemCount(Long itemCount) Represents the number of items in the index.
LocalSecondaryIndexDescription	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).
LocalSecondaryIndexDescription	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).
LocalSecondaryIndexDescription	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

LocalSecondaryIndexDescription

public LocalSecondaryIndexDescription()

Method Detail

getIndexName

public String getIndexName()

Represents the name of the secondary index.

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

Returns:

Represents the name of the secondary index.

setIndexName

public void setIndexName(String indexName)

Represents the name of the secondary index.

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

Parameters:

indexName - Represents the name of the secondary index.

withIndexName

public LocalSecondaryIndexDescription withIndexName(String indexName)

Represents the name of the secondary index.

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.

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 LocalSecondaryIndexDescription 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 LocalSecondaryIndexDescription 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 LocalSecondaryIndexDescription 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.

getIndexSizeBytes

public Long getIndexSizeBytes()

Represents the total size of the index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

Represents the total size of the index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

setIndexSizeBytes

public void setIndexSizeBytes(Long indexSizeBytes)

Represents the total size of the index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Parameters:

indexSizeBytes - Represents the total size of the index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

withIndexSizeBytes

public LocalSecondaryIndexDescription withIndexSizeBytes(Long indexSizeBytes)

Represents the total size of the index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

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

Parameters:

indexSizeBytes - Represents the total size of the index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

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

getItemCount

public Long getItemCount()

Represents the number of items in the index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

Represents the number of items in the index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

setItemCount

public void setItemCount(Long itemCount)

Represents the number of items in the index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Parameters:

itemCount - Represents the number of items in the index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

withItemCount

public LocalSecondaryIndexDescription withItemCount(Long itemCount)

Represents the number of items in the index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

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

Parameters:

itemCount - Represents the number of items in the index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

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