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 Description LocalSecondaryIndexDescription()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:Projection
getProjection()
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)
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(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(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
withProjection(Projection projection)
-
-
-
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 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:
- 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.
- 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.
NOTE: This method appends the values to the existing list (if any). Use
setKeySchema(java.util.Collection)
orwithKeySchema(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this 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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
setProjection
public void setProjection(Projection projection)
- Parameters:
projection
-
-
getProjection
public Projection getProjection()
- Returns:
-
withProjection
public LocalSecondaryIndexDescription withProjection(Projection projection)
- Parameters:
projection
-- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public LocalSecondaryIndexDescription clone()
-
-