LocalSecondaryIndexDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LocalSecondaryIndexDescription()

Constructors
Constructor and Description
`LocalSecondaryIndexDescription()`

Method Summary

All Methods Instance Methods Concrete 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 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)` Marshalls this structured data using the given `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.

Methods inherited from class java.lang.Object
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 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.
    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'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.
  - 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'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.
    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'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.
  - 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'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.
    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'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.
    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'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.
    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'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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProjection
```
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.
    
    Parameters:
    
    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.
  - getProjection
```
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.
    
    Returns:
    
    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.
  - withProjection
```
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.
    
    Parameters:
    
    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.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class LocalSecondaryIndexDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LocalSecondaryIndexDescription

Method Detail

setIndexName

getIndexName

withIndexName

getKeySchema

setKeySchema

withKeySchema

withKeySchema

setProjection

getProjection

withProjection

setIndexSizeBytes

getIndexSizeBytes

withIndexSizeBytes

setItemCount

getItemCount

withItemCount

setIndexArn

getIndexArn

withIndexArn

toString

equals

hashCode

clone

marshall