ConsumedCapacity (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dynamodbv2.model.ConsumedCapacity

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConsumedCapacity
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConsumedCapacity()

Constructors
Constructor and Description
`ConsumedCapacity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConsumedCapacity`	`addGlobalSecondaryIndexesEntry(String key, Capacity value)`
`ConsumedCapacity`	`addLocalSecondaryIndexesEntry(String key, Capacity value)`
`ConsumedCapacity`	`clearGlobalSecondaryIndexesEntries()` Removes all the entries added into GlobalSecondaryIndexes.
`ConsumedCapacity`	`clearLocalSecondaryIndexesEntries()` Removes all the entries added into LocalSecondaryIndexes.
`ConsumedCapacity`	`clone()`
`boolean`	`equals(Object obj)`
`Double`	`getCapacityUnits()` The total number of capacity units consumed by the operation.
`Map<String,Capacity>`	`getGlobalSecondaryIndexes()` The amount of throughput consumed on each global index affected by the operation.
`Map<String,Capacity>`	`getLocalSecondaryIndexes()` The amount of throughput consumed on each local index affected by the operation.
`Capacity`	`getTable()` The amount of throughput consumed on the table affected by the operation.
`String`	`getTableName()` The name of the table that was affected by the operation.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCapacityUnits(Double capacityUnits)` The total number of capacity units consumed by the operation.
`void`	`setGlobalSecondaryIndexes(Map<String,Capacity> globalSecondaryIndexes)` The amount of throughput consumed on each global index affected by the operation.
`void`	`setLocalSecondaryIndexes(Map<String,Capacity> localSecondaryIndexes)` The amount of throughput consumed on each local index affected by the operation.
`void`	`setTable(Capacity table)` The amount of throughput consumed on the table affected by the operation.
`void`	`setTableName(String tableName)` The name of the table that was affected by the operation.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ConsumedCapacity`	`withCapacityUnits(Double capacityUnits)` The total number of capacity units consumed by the operation.
`ConsumedCapacity`	`withGlobalSecondaryIndexes(Map<String,Capacity> globalSecondaryIndexes)` The amount of throughput consumed on each global index affected by the operation.
`ConsumedCapacity`	`withLocalSecondaryIndexes(Map<String,Capacity> localSecondaryIndexes)` The amount of throughput consumed on each local index affected by the operation.
`ConsumedCapacity`	`withTable(Capacity table)` The amount of throughput consumed on the table affected by the operation.
`ConsumedCapacity`	`withTableName(String tableName)` The name of the table that was affected by the operation.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConsumedCapacity
```
public ConsumedCapacity()
```
- Method Detail
  - setTableName
```
public void setTableName(String tableName)
```
    The name of the table that was affected by the operation.
    
    Parameters:
    
    tableName - The name of the table that was affected by the operation.
  - getTableName
```
public String getTableName()
```
    The name of the table that was affected by the operation.
    
    Returns:
    
    The name of the table that was affected by the operation.
  - withTableName
```
public ConsumedCapacity withTableName(String tableName)
```
    The name of the table that was affected by the operation.
    
    Parameters:
    
    tableName - The name of the table that was affected by the operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCapacityUnits
```
public void setCapacityUnits(Double capacityUnits)
```
    The total number of capacity units consumed by the operation.
    
    Parameters:
    
    capacityUnits - The total number of capacity units consumed by the operation.
  - getCapacityUnits
```
public Double getCapacityUnits()
```
    The total number of capacity units consumed by the operation.
    
    Returns:
    
    The total number of capacity units consumed by the operation.
  - withCapacityUnits
```
public ConsumedCapacity withCapacityUnits(Double capacityUnits)
```
    The total number of capacity units consumed by the operation.
    
    Parameters:
    
    capacityUnits - The total number of capacity units consumed by the operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTable
```
public void setTable(Capacity table)
```
    The amount of throughput consumed on the table affected by the operation.
    
    Parameters:
    
    table - The amount of throughput consumed on the table affected by the operation.
  - getTable
```
public Capacity getTable()
```
    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.
  - withTable
```
public ConsumedCapacity withTable(Capacity table)
```
    The amount of throughput consumed on the table affected by the operation.
    
    Parameters:
    
    table - The amount of throughput consumed on the table affected by the operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLocalSecondaryIndexes
```
public Map<String,Capacity> getLocalSecondaryIndexes()
```
    The amount of throughput consumed on each local index affected by the operation.
    
    Returns:
    
    The amount of throughput consumed on each local index affected by the operation.
  - setLocalSecondaryIndexes
```
public void setLocalSecondaryIndexes(Map<String,Capacity> localSecondaryIndexes)
```
    The amount of throughput consumed on each local index affected by the operation.
    
    Parameters:
    
    localSecondaryIndexes - The amount of throughput consumed on each local index affected by the operation.
  - withLocalSecondaryIndexes
```
public ConsumedCapacity withLocalSecondaryIndexes(Map<String,Capacity> localSecondaryIndexes)
```
    The amount of throughput consumed on each local index affected by the operation.
    
    Parameters:
    
    localSecondaryIndexes - The amount of throughput consumed on each local index affected by the operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addLocalSecondaryIndexesEntry
```
public ConsumedCapacity addLocalSecondaryIndexesEntry(String key,
                                                      Capacity value)
```
  - clearLocalSecondaryIndexesEntries
```
public ConsumedCapacity clearLocalSecondaryIndexesEntries()
```
    Removes all the entries added into LocalSecondaryIndexes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getGlobalSecondaryIndexes
```
public Map<String,Capacity> getGlobalSecondaryIndexes()
```
    The amount of throughput consumed on each global index affected by the operation.
    
    Returns:
    
    The amount of throughput consumed on each global index affected by the operation.
  - setGlobalSecondaryIndexes
```
public void setGlobalSecondaryIndexes(Map<String,Capacity> globalSecondaryIndexes)
```
    The amount of throughput consumed on each global index affected by the operation.
    
    Parameters:
    
    globalSecondaryIndexes - The amount of throughput consumed on each global index affected by the operation.
  - withGlobalSecondaryIndexes
```
public ConsumedCapacity withGlobalSecondaryIndexes(Map<String,Capacity> globalSecondaryIndexes)
```
    The amount of throughput consumed on each global index affected by the operation.
    
    Parameters:
    
    globalSecondaryIndexes - The amount of throughput consumed on each global index affected by the operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addGlobalSecondaryIndexesEntry
```
public ConsumedCapacity addGlobalSecondaryIndexesEntry(String key,
                                                       Capacity value)
```
  - clearGlobalSecondaryIndexesEntries
```
public ConsumedCapacity clearGlobalSecondaryIndexesEntries()
```
    Removes all the entries added into GlobalSecondaryIndexes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ConsumedCapacity clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ConsumedCapacity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsumedCapacity

Method Detail

setTableName

getTableName

withTableName

setCapacityUnits

getCapacityUnits

withCapacityUnits

setTable

getTable

withTable

getLocalSecondaryIndexes

setLocalSecondaryIndexes

withLocalSecondaryIndexes

addLocalSecondaryIndexesEntry

clearLocalSecondaryIndexesEntries

getGlobalSecondaryIndexes

setGlobalSecondaryIndexes

withGlobalSecondaryIndexes

addGlobalSecondaryIndexesEntry

clearGlobalSecondaryIndexesEntries

toString

equals

hashCode

clone

marshall