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 local secondary index.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalSecondaryIndexDescription()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getIndexArn() The Amazon Resource Name (ARN) that uniquely identifies the index.
String	getIndexName() Represents the name of the local secondary index.
Long	getIndexSizeBytes() The total size of the specified index, in bytes.
Long	getItemCount() The number of items in the specified index.
List<KeySchemaElement>	getKeySchema() The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
Projection	getProjection() Represents attributes that are copied (projected) from the table into an index.
int	hashCode()
void	setIndexArn(String indexArn) The Amazon Resource Name (ARN) that uniquely identifies the index.
void	setIndexName(String indexName) Represents the name of the local secondary index.
void	setIndexSizeBytes(Long indexSizeBytes) The total size of the specified index, in bytes.
void	setItemCount(Long itemCount) The number of items in the specified index.
void	setKeySchema(Collection<KeySchemaElement> keySchema) The complete key schema for the local secondary index, consisting 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 an index.
String	toString() Returns a string representation of this object; useful for testing and debugging.
LocalSecondaryIndexDescription	withIndexArn(String indexArn) The Amazon Resource Name (ARN) that uniquely identifies the index.
LocalSecondaryIndexDescription	withIndexName(String indexName) Represents the name of the local secondary index.
LocalSecondaryIndexDescription	withIndexSizeBytes(Long indexSizeBytes) The total size of the specified index, in bytes.
LocalSecondaryIndexDescription	withItemCount(Long itemCount) The number of items in the specified index.
LocalSecondaryIndexDescription	withKeySchema(Collection<KeySchemaElement> keySchema) The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
LocalSecondaryIndexDescription	withKeySchema(KeySchemaElement... keySchema) The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
LocalSecondaryIndexDescription	withProjection(Projection projection) Represents attributes that are copied (projected) from the table into an index.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalSecondaryIndexDescription

public LocalSecondaryIndexDescription()

Method Detail

getIndexName

public String getIndexName()

Represents the name of the local secondary index.

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

Returns:

Represents the name of the local secondary index.

setIndexName

public void setIndexName(String indexName)

Represents the name of the local secondary index.

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

Parameters:

indexName - Represents the name of the local secondary index.

withIndexName

public LocalSecondaryIndexDescription withIndexName(String indexName)

Represents the name of the local 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 local secondary index.

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 the local secondary index, consisting 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.

Constraints:
Length: 1 - 2

Returns:

The complete key schema for the local secondary index, consisting 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 the local secondary index, consisting 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.

Constraints:
Length: 1 - 2

Parameters:

keySchema - The complete key schema for the local secondary index, consisting 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 LocalSecondaryIndexDescription withKeySchema(KeySchemaElement... keySchema)

The complete key schema for the local secondary index, consisting 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

Parameters:

keySchema - The complete key schema for the local secondary index, consisting 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:

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

withKeySchema

public LocalSecondaryIndexDescription withKeySchema(Collection<KeySchemaElement> keySchema)

The complete key schema for the local secondary index, consisting 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2

Parameters:

keySchema - The complete key schema for the local secondary index, consisting 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:

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

getIndexSizeBytes

public Long getIndexSizeBytes()

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

Returns:

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

setIndexSizeBytes

public void setIndexSizeBytes(Long indexSizeBytes)

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

Parameters:

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

withIndexSizeBytes

public LocalSecondaryIndexDescription withIndexSizeBytes(Long indexSizeBytes)

The total size of the specified index, in bytes. 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 - The total size of the specified index, in bytes. 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()

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

Returns:

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

setItemCount

public void setItemCount(Long itemCount)

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

Parameters:

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

withItemCount

public LocalSecondaryIndexDescription withItemCount(Long itemCount)

The number of items in the specified index. 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 - The number of items in the specified index. 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.

getIndexArn

public String getIndexArn()

The Amazon Resource Name (ARN) that uniquely identifies the index.

Returns:

The Amazon Resource Name (ARN) that uniquely identifies the index.

setIndexArn

public void setIndexArn(String indexArn)

The Amazon Resource Name (ARN) that uniquely identifies the index.

Parameters:

indexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.

withIndexArn

public LocalSecondaryIndexDescription withIndexArn(String indexArn)

The Amazon Resource Name (ARN) that uniquely identifies the index.

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

Parameters:

indexArn - The Amazon Resource Name (ARN) that uniquely identifies the index.

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