com.amazonaws.services.dynamodbv2.model

Class LocalSecondaryIndexDescription

java.lang.Object

com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription

All Implemented Interfaces:

Serializable, Cloneable

public class LocalSecondaryIndexDescription
extends Object
implements Serializable, Cloneable

Represents the properties of a local secondary index.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LocalSecondaryIndexDescription()

Method Summary

Methods

Modifier and Type	Method and Description
LocalSecondaryIndexDescription	clone()
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 index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).
Projection	getProjection() Returns the value of the Projection property for this object.
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 index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).
void	setProjection(Projection projection) Sets the value of the Projection property for this object.
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 index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).
LocalSecondaryIndexDescription	withKeySchema(KeySchemaElement... keySchema) 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) Sets the value of the Projection property for this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalSecondaryIndexDescription

public LocalSecondaryIndexDescription()

Method Detail

setIndexName

public void setIndexName(String indexName)

Represents the name of the local secondary index.

Parameters:

indexName - Represents the name of the local secondary index.

getIndexName

public String getIndexName()

Represents the name of the local secondary index.

Returns:

Represents the name of the local secondary index.

withIndexName

public LocalSecondaryIndexDescription withIndexName(String indexName)

Represents the name of the local secondary index.

Parameters:

indexName - Represents the name of the local secondary index.

Returns:

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

getKeySchema

public List<KeySchemaElement> getKeySchema()

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

Returns:

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)

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

Parameters:

keySchema - 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)

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

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 index key schema, which consists of one or more pairs of attribute names and key types (HASH or RANGE).

Returns:

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

withKeySchema

public LocalSecondaryIndexDescription withKeySchema(Collection<KeySchemaElement> keySchema)

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

Parameters:

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

Returns:

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

setProjection

public void setProjection(Projection projection)

Sets the value of the Projection property for this object.

Parameters:

projection - The new value for the Projection property for this object.

getProjection

public Projection getProjection()

Returns the value of the Projection property for this object.

Returns:

The value of the Projection property for this object.

withProjection

public LocalSecondaryIndexDescription withProjection(Projection projection)

Sets the value of the Projection property for this object.

Parameters:

projection - The new value for the Projection property for this object.

Returns:

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

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.

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.

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.

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:

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

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.

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.

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.

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:

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

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.

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.

withIndexArn

public LocalSecondaryIndexDescription withIndexArn(String indexArn)

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

Parameters:

indexArn - The Amazon Resource Name (ARN) that uniquely identifies the 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; useful for testing and debugging.

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 LocalSecondaryIndexDescription clone()

Overrides:

clone in class Object