software.amazon.awssdk.services.dynamodb.model

Class ItemCollectionMetrics

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.ItemCollectionMetrics

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ItemCollectionMetrics.Builder,ItemCollectionMetrics>

@Generated(value="software.amazon.awssdk:codegen")
public final class ItemCollectionMetrics
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ItemCollectionMetrics.Builder,ItemCollectionMetrics>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ItemCollectionMetrics.Builder

Method Summary

Modifier and Type	Method and Description
static ItemCollectionMetrics.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItemCollectionKey() Returns true if the ItemCollectionKey property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSizeEstimateRangeGB() Returns true if the SizeEstimateRangeGB property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,AttributeValue>	itemCollectionKey() The partition key value of the item collection.
List<SdkField<?>>	sdkFields()
static Class<? extends ItemCollectionMetrics.Builder>	serializableBuilderClass()
List<Double>	sizeEstimateRangeGB() An estimate of item collection size, in gigabytes.
ItemCollectionMetrics.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasItemCollectionKey

public boolean hasItemCollectionKey()

Returns true if the ItemCollectionKey property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

itemCollectionKey

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasItemCollectionKey() to see if a value was sent in this field.

Returns:

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

hasSizeEstimateRangeGB

public boolean hasSizeEstimateRangeGB()

Returns true if the SizeEstimateRangeGB property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

sizeEstimateRangeGB

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSizeEstimateRangeGB() to see if a value was sent in this field.

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.

toBuilder

public ItemCollectionMetrics.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ItemCollectionMetrics.Builder,ItemCollectionMetrics>

builder

public static ItemCollectionMetrics.Builder builder()

serializableBuilderClass

public static Class<? extends ItemCollectionMetrics.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo