java.lang.Object
- software.amazon.awssdk.services.dynamodb.model.ConsumedCapacity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConsumedCapacity.Builder,ConsumedCapacity>
```
@Generated("software.amazon.awssdk:codegen")
public final class ConsumedCapacity
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ConsumedCapacity.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ConsumedCapacity.Builder`	`builder()`
`Double`	`capacityUnits()`	The total number of capacity units consumed by the operation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`Map<String,Capacity>`	`globalSecondaryIndexes()`	The amount of throughput consumed on each global index affected by the operation.
`boolean`	`hasGlobalSecondaryIndexes()`	For responses, this returns true if the service returned a value for the GlobalSecondaryIndexes property.
`int`	`hashCode()`
`boolean`	`hasLocalSecondaryIndexes()`	For responses, this returns true if the service returned a value for the LocalSecondaryIndexes property.
`Map<String,Capacity>`	`localSecondaryIndexes()`	The amount of throughput consumed on each local index affected by the operation.
`Double`	`readCapacityUnits()`	The total number of read capacity units consumed by the operation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ConsumedCapacity.Builder>`	`serializableBuilderClass()`
`Capacity`	`table()`	The amount of throughput consumed on the table affected by the operation.
`String`	`tableName()`	The name of the table that was affected by the operation.
`ConsumedCapacity.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Double`	`writeCapacityUnits()`	The total number of write capacity units consumed by the operation.

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
  - tableName
```
public final String tableName()
```
    The name of the table that was affected by the operation.
    
    Returns:
    
    The name of the table that was affected by the operation.
  - capacityUnits
```
public final Double capacityUnits()
```
    The total number of capacity units consumed by the operation.
    
    Returns:
    
    The total number of capacity units consumed by the operation.
  - readCapacityUnits
```
public final Double 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
```
public final Double 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
```
public final Capacity 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 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.
  - localSecondaryIndexes
```
public final Map<String,Capacity> 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 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.
  - globalSecondaryIndexes
```
public final Map<String,Capacity> 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
```
public ConsumedCapacity.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ConsumedCapacity.Builder,ConsumedCapacity>
  - builder
```
public static ConsumedCapacity.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ConsumedCapacity.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

Class ConsumedCapacity

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

tableName

capacityUnits

readCapacityUnits

writeCapacityUnits

table

hasLocalSecondaryIndexes

localSecondaryIndexes

hasGlobalSecondaryIndexes

globalSecondaryIndexes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields