ConsumedCapacity (AWS SDK for Java 1.8.12 API)

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

All Implemented Interfaces:

Serializable
```
public class ConsumedCapacity
extends Object
implements Serializable
```
Represents 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 it was asked for in the request. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConsumedCapacity()

Constructors
Constructor and Description
`ConsumedCapacity()`

Method Summary

Methods
Modifier and Type	Method and Description
`ConsumedCapacity`	`addGlobalSecondaryIndexesEntry(String key, Capacity value)` The amount of throughput consumed on each global index affected by the operation.
`ConsumedCapacity`	`addLocalSecondaryIndexesEntry(String key, Capacity value)` The amount of throughput consumed on each local index affected by the operation.
`ConsumedCapacity`	`clearGlobalSecondaryIndexesEntries()` Removes all the entries added into GlobalSecondaryIndexes.
`ConsumedCapacity`	`clearLocalSecondaryIndexesEntries()` Removes all the entries added into LocalSecondaryIndexes.
`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`	`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConsumedCapacity
```
public ConsumedCapacity()
```
- Method Detail
  - getTableName
```
public String getTableName()
```
    The name of the table that was affected by the operation.
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The name of the table that was affected by the operation.
  - setTableName
```
public void setTableName(String tableName)
```
    The name of the table that was affected by the operation.
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    tableName - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 3 - 255
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    tableName - The name of the table that was affected by the operation.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withCapacityUnits
```
public ConsumedCapacity withCapacityUnits(Double capacityUnits)
```
    The total number of capacity units consumed by the operation.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    capacityUnits - The total number of capacity units consumed by the operation.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withTable
```
public ConsumedCapacity withTable(Capacity table)
```
    The amount of throughput consumed on the table affected by the operation.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    table - The amount of throughput consumed on the table affected by the operation.
    
    Returns:
    A reference to this updated 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    localSecondaryIndexes - The amount of throughput consumed on each local index affected by the operation.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addLocalSecondaryIndexesEntry
```
public ConsumedCapacity addLocalSecondaryIndexesEntry(String key,
                                             Capacity value)
```
    The amount of throughput consumed on each local index affected by the operation.
    The method adds a new key-value pair into LocalSecondaryIndexes parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    key - The key of the entry to be added into LocalSecondaryIndexes.
    value - The corresponding value of the entry to be added into LocalSecondaryIndexes.
  - clearLocalSecondaryIndexesEntries
```
public ConsumedCapacity clearLocalSecondaryIndexesEntries()
```
    Removes all the entries added into LocalSecondaryIndexes.
    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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    globalSecondaryIndexes - The amount of throughput consumed on each global index affected by the operation.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addGlobalSecondaryIndexesEntry
```
public ConsumedCapacity addGlobalSecondaryIndexesEntry(String key,
                                              Capacity value)
```
    The amount of throughput consumed on each global index affected by the operation.
    The method adds a new key-value pair into GlobalSecondaryIndexes parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    key - The key of the entry to be added into GlobalSecondaryIndexes.
    value - The corresponding value of the entry to be added into GlobalSecondaryIndexes.
  - clearGlobalSecondaryIndexesEntries
```
public ConsumedCapacity clearGlobalSecondaryIndexesEntries()
```
    Removes all the entries added into GlobalSecondaryIndexes.
    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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class ConsumedCapacity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsumedCapacity

Method Detail

getTableName

setTableName

withTableName

getCapacityUnits

setCapacityUnits

withCapacityUnits

getTable

setTable

withTable

getLocalSecondaryIndexes

setLocalSecondaryIndexes

withLocalSecondaryIndexes

addLocalSecondaryIndexesEntry

clearLocalSecondaryIndexesEntries

getGlobalSecondaryIndexes

setGlobalSecondaryIndexes

withGlobalSecondaryIndexes

addGlobalSecondaryIndexesEntry

clearGlobalSecondaryIndexesEntries

toString

hashCode

equals