Package 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("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	Description
static interface	ItemCollectionMetrics.Builder

Method Summary

Modifier and Type	Method	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()	For responses, this returns true if the service returned a value for the ItemCollectionKey property.
boolean	hasSizeEstimateRangeGB()	For responses, this returns true if the service returned a value for the SizeEstimateRangeGB property.
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 final boolean hasItemCollectionKey()

For responses, this returns true if the service returned a value for the ItemCollectionKey property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

itemCollectionKey

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItemCollectionKey() method.

Returns:

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

hasSizeEstimateRangeGB

public final boolean hasSizeEstimateRangeGB()

For responses, this returns true if the service returned a value for the SizeEstimateRangeGB property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sizeEstimateRangeGB

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSizeEstimateRangeGB() method.

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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo