Class ItemCollectionMetrics
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.model.ItemCollectionMetrics
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class ItemCollectionMetrics extends Object implements Serializable, Cloneable
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 Description ItemCollectionMetrics()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
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(Double... sizeEstimateRangeGB)
An estimate of item collection size, in gigabytes.ItemCollectionMetrics
withSizeEstimateRangeGB(Collection<Double> sizeEstimateRangeGB)
An estimate of item collection size, in gigabytes.
-
-
-
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. <p> 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)
orwithSizeEstimateRangeGB(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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ItemCollectionMetrics clone()
-
-