Class ConsumedCapacity
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ConsumedCapacity.Builder,
ConsumedCapacity>
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed,
along with statistics for the table and any indexes involved in the operation. ConsumedCapacity
is only
returned if the request asked for it. For more information, see Provisioned
Throughput in the Amazon DynamoDB Developer Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ConsumedCapacity.Builder
builder()
final Double
The total number of capacity units consumed by the operation.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) The amount of throughput consumed on each global index affected by the operation.final boolean
For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LocalSecondaryIndexes property.The amount of throughput consumed on each local index affected by the operation.final Double
The total number of read capacity units consumed by the operation.static Class
<? extends ConsumedCapacity.Builder> final Capacity
table()
The amount of throughput consumed on the table affected by the operation.final String
The name of the table that was affected by the operation.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.final Double
The total number of write capacity units consumed by the operation.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
tableName
The name of the table that was affected by the operation. If you had specified the Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.
- Returns:
- The name of the table that was affected by the operation. If you had specified the Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.
-
capacityUnits
The total number of capacity units consumed by the operation.
- Returns:
- The total number of capacity units consumed by the operation.
-
readCapacityUnits
The total number of read capacity units consumed by the operation.
- Returns:
- The total number of read capacity units consumed by the operation.
-
writeCapacityUnits
The total number of write capacity units consumed by the operation.
- Returns:
- The total number of write capacity units consumed by the operation.
-
table
The amount of throughput consumed on the table affected by the operation.
- Returns:
- The amount of throughput consumed on the table affected by the operation.
-
hasLocalSecondaryIndexes
public final boolean hasLocalSecondaryIndexes()For responses, this returns true if the service returned a value for the LocalSecondaryIndexes 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. -
localSecondaryIndexes
The amount of throughput consumed on each local index affected by the operation.
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
hasLocalSecondaryIndexes()
method.- Returns:
- The amount of throughput consumed on each local index affected by the operation.
-
hasGlobalSecondaryIndexes
public final boolean hasGlobalSecondaryIndexes()For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes 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. -
globalSecondaryIndexes
The amount of throughput consumed on each global index affected by the operation.
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
hasGlobalSecondaryIndexes()
method.- Returns:
- The amount of throughput consumed on each global index affected by the operation.
-
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<ConsumedCapacity.Builder,
ConsumedCapacity> - 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
-