@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class LocalSecondaryIndexDescription extends Object implements Serializable, Cloneable, StructuredPojo
Represents the properties of a local secondary index.
Constructor and Description |
---|
LocalSecondaryIndexDescription() |
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 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 the global secondary index.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
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 the global secondary index.
|
String |
toString()
Returns a string representation of this object.
|
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 the global secondary index.
|
public void setIndexName(String indexName)
Represents the name of the local secondary index.
indexName
- Represents the name of the local secondary index.public String getIndexName()
Represents the name of the local secondary index.
public LocalSecondaryIndexDescription withIndexName(String indexName)
Represents the name of the local secondary index.
indexName
- Represents the name of the local secondary index.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's 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.
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's 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.
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's 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.
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's 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.
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's 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)
or withKeySchema(java.util.Collection)
if you want to
override the existing values.
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's 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.
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's 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.
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's 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.
public void setProjection(Projection projection)
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
projection
- Represents attributes that are copied (projected) from the table into the global secondary index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected.public Projection getProjection()
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
public LocalSecondaryIndexDescription withProjection(Projection projection)
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
projection
- Represents attributes that are copied (projected) from the table into the global secondary index. These
are in addition to the primary key attributes and index key attributes, which are automatically projected.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.
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.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.
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.
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.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.
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.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.
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.
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.public void setIndexArn(String indexArn)
The Amazon Resource Name (ARN) that uniquely identifies the index.
indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.public String getIndexArn()
The Amazon Resource Name (ARN) that uniquely identifies the index.
public LocalSecondaryIndexDescription withIndexArn(String indexArn)
The Amazon Resource Name (ARN) that uniquely identifies the index.
indexArn
- The Amazon Resource Name (ARN) that uniquely identifies the index.public String toString()
toString
in class Object
Object.toString()
public LocalSecondaryIndexDescription clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2020. All rights reserved.