Class LocalSecondaryIndexDescription
- All Implemented Interfaces:
Serializable
,Cloneable
Represents the properties of a local secondary index.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The Amazon Resource Name (ARN) that uniquely identifies the index.Represents the name of the local secondary index.The total size of the specified index, in bytes.The number of items in the specified index.The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: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) toString()
Returns a string representation of this object; useful for testing and debugging.withIndexArn
(String indexArn) The Amazon Resource Name (ARN) that uniquely identifies the index.withIndexName
(String indexName) Represents the name of the local secondary index.withIndexSizeBytes
(Long indexSizeBytes) The total size of the specified index, in bytes.withItemCount
(Long itemCount) The number of items in the specified index.withKeySchema
(KeySchemaElement... keySchema) The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: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:withProjection
(Projection projection)
-
Constructor Details
-
LocalSecondaryIndexDescription
public LocalSecondaryIndexDescription()
-
-
Method Details
-
setIndexName
Represents the name of the local secondary index.
- Parameters:
indexName
- Represents the name of the local secondary index.
-
getIndexName
Represents the name of the local secondary index.
- Returns:
- Represents the name of the local secondary index.
-
withIndexName
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
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
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
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
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
- Parameters:
projection
-
-
getProjection
- Returns:
-
withProjection
- Parameters:
projection
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIndexSizeBytes
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
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
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
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
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
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
The Amazon Resource Name (ARN) that uniquely identifies the index.
- Parameters:
indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.
-
getIndexArn
The Amazon Resource Name (ARN) that uniquely identifies the index.
- Returns:
- The Amazon Resource Name (ARN) that uniquely identifies the index.
-
withIndexArn
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-