Class ItemCollectionMetrics
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ItemCollectionKey property.final boolean
For responses, this returns true if the service returned a value for the SizeEstimateRangeGB property.final Map
<String, AttributeValue> The partition key value of the item collection.static Class
<? extends ItemCollectionMetrics.Builder> An estimate of item collection size, in gigabytes.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ItemCollectionMetrics.Builder,
ItemCollectionMetrics> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-