com.amazonaws.services.dynamodbv2.model

Class ItemCollectionMetrics

java.lang.Object

com.amazonaws.services.dynamodbv2.model.ItemCollectionMetrics

All Implemented Interfaces:

Serializable

public class ItemCollectionMetrics
extends Object
implements Serializable

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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ItemCollectionMetrics()

Method Summary

Methods

Modifier and Type	Method and Description
ItemCollectionMetrics	addItemCollectionKeyEntry(String key, AttributeValue value) The hash key value of the item collection.
ItemCollectionMetrics	clearItemCollectionKeyEntries() Removes all the entries added into ItemCollectionKey.
boolean	equals(Object obj)
Map<String,AttributeValue>	getItemCollectionKey() The hash key value of the item collection.
List<Double>	getSizeEstimateRangeGB() An estimate of item collection size, in gigabytes.
int	hashCode()
void	setItemCollectionKey(Map<String,AttributeValue> itemCollectionKey) The hash 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 hash 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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ItemCollectionMetrics

public ItemCollectionMetrics()

Method Detail

getItemCollectionKey

public Map<String,AttributeValue> getItemCollectionKey()

The hash key value of the item collection. This value is the same as the hash key of the item.

Returns:

The hash key value of the item collection. This value is the same as the hash key of the item.

setItemCollectionKey

public void setItemCollectionKey(Map<String,AttributeValue> itemCollectionKey)

The hash key value of the item collection. This value is the same as the hash key of the item.

Parameters:

itemCollectionKey - The hash key value of the item collection. This value is the same as the hash key of the item.

withItemCollectionKey

public ItemCollectionMetrics withItemCollectionKey(Map<String,AttributeValue> itemCollectionKey)

The hash key value of the item collection. This value is the same as the hash key of the item.

Returns a reference to this object so that method calls can be chained together.

Parameters:

itemCollectionKey - The hash key value of the item collection. This value is the same as the hash key of the item.

Returns:

A reference to this updated object so that method calls can be chained together.

addItemCollectionKeyEntry

public ItemCollectionMetrics addItemCollectionKeyEntry(String key,
                                              AttributeValue value)

The hash key value of the item collection. This value is the same as the hash key of the item.

The method adds a new key-value pair into ItemCollectionKey parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into ItemCollectionKey.

value - The corresponding value of the entry to be added into ItemCollectionKey.

clearItemCollectionKeyEntries

public ItemCollectionMetrics clearItemCollectionKeyEntries()

Removes all the entries added into ItemCollectionKey.

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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated 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.

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object