ItemCollectionMetrics (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ItemCollectionMetrics
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ItemCollectionMetrics()

Constructors
Constructor and Description
`ItemCollectionMetrics()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ItemCollectionMetrics`	`addItemCollectionKeyEntry(String key, AttributeValue value)`
`ItemCollectionMetrics`	`clearItemCollectionKeyEntries()` Removes all the entries added into ItemCollectionKey.
`ItemCollectionMetrics`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,AttributeValue>`	`getItemCollectionKey()` The partition key value of the item collection.
`List<Double>`	`getSizeEstimateRangeGB()` An estimate of item collection size, in gigabytes.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setItemCollectionKey(Map<String,AttributeValue> itemCollectionKey)` The partition key value of the item collection.
`void`	`setSizeEstimateRangeGB(Collection<Double> sizeEstimateRangeGB)` An estimate of item collection size, in gigabytes.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ItemCollectionMetrics`	`withItemCollectionKey(Map<String,AttributeValue> itemCollectionKey)` The partition key value of the item collection.
`ItemCollectionMetrics`	`withSizeEstimateRangeGB(Collection<Double> sizeEstimateRangeGB)` An estimate of item collection size, in gigabytes.
`ItemCollectionMetrics`	`withSizeEstimateRangeGB(Double... sizeEstimateRangeGB)` An estimate of item collection size, in gigabytes.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ItemCollectionMetrics
```
public ItemCollectionMetrics()
```
- Method Detail
  - getItemCollectionKey
```
public Map<String,AttributeValue> getItemCollectionKey()
```
    The partition key value of the item collection. This value is the same as the partition key value of the item.
    
    Returns:
    
    The partition key value of the item collection. This value is the same as the partition key value of the item.
  - setItemCollectionKey
```
public void setItemCollectionKey(Map<String,AttributeValue> itemCollectionKey)
```
    The partition key value of the item collection. This value is the same as the partition key value of the item.
    
    Parameters:
    
    itemCollectionKey - The partition key value of the item collection. This value is the same as the partition key value of the item.
  - withItemCollectionKey
```
public ItemCollectionMetrics withItemCollectionKey(Map<String,AttributeValue> itemCollectionKey)
```
    The partition key value of the item collection. This value is the same as the partition key value of the item.
    
    Parameters:
    
    itemCollectionKey - The partition key value of the item collection. This value is the same as the partition key value of the item.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addItemCollectionKeyEntry
```
public ItemCollectionMetrics addItemCollectionKeyEntry(String key,
                                                       AttributeValue value)
```
  - clearItemCollectionKeyEntries
```
public ItemCollectionMetrics clearItemCollectionKeyEntries()
```
    Removes all the entries added into ItemCollectionKey.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSizeEstimateRangeGB
```
public List<Double> getSizeEstimateRangeGB()
```
    An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    
    Returns:
    
    An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
  - setSizeEstimateRangeGB
```
public void setSizeEstimateRangeGB(Collection<Double> sizeEstimateRangeGB)
```
    An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    
    Parameters:
    
    sizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
  - withSizeEstimateRangeGB
```
public ItemCollectionMetrics withSizeEstimateRangeGB(Double... sizeEstimateRangeGB)
```
    An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    
    NOTE: This method appends the values to the existing list (if any). Use setSizeEstimateRangeGB(java.util.Collection) or withSizeEstimateRangeGB(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSizeEstimateRangeGB
```
public ItemCollectionMetrics withSizeEstimateRangeGB(Collection<Double> sizeEstimateRangeGB)
```
    An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    
    Parameters:
    
    sizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
    
    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
    
    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 ItemCollectionMetrics 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 ItemCollectionMetrics

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ItemCollectionMetrics

Method Detail

getItemCollectionKey

setItemCollectionKey

withItemCollectionKey

addItemCollectionKeyEntry

clearItemCollectionKeyEntries

getSizeEstimateRangeGB

setSizeEstimateRangeGB

withSizeEstimateRangeGB

withSizeEstimateRangeGB

toString

equals

hashCode

clone

marshall