com.amazonaws.services.dynamodbv2.model

Class ConsumedCapacity

java.lang.Object

com.amazonaws.services.dynamodbv2.model.ConsumedCapacity

All Implemented Interfaces:

java.io.Serializable

public class ConsumedCapacity
extends java.lang.Object
implements java.io.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()

Method Summary

Methods

Modifier and Type	Method and Description
ConsumedCapacity	addGlobalSecondaryIndexesEntry(java.lang.String key, Capacity value) The amount of throughput consumed on each global index affected by the operation.
ConsumedCapacity	addLocalSecondaryIndexesEntry(java.lang.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(java.lang.Object obj)
java.lang.Double	getCapacityUnits() The total number of capacity units consumed by the operation.
java.util.Map<java.lang.String,Capacity>	getGlobalSecondaryIndexes() The amount of throughput consumed on each global index affected by the operation.
java.util.Map<java.lang.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.
java.lang.String	getTableName() The name of the table that was affected by the operation.
int	hashCode()
void	setCapacityUnits(java.lang.Double capacityUnits) The total number of capacity units consumed by the operation.
void	setGlobalSecondaryIndexes(java.util.Map<java.lang.String,Capacity> globalSecondaryIndexes) The amount of throughput consumed on each global index affected by the operation.
void	setLocalSecondaryIndexes(java.util.Map<java.lang.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(java.lang.String tableName) The name of the table that was affected by the operation.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ConsumedCapacity	withCapacityUnits(java.lang.Double capacityUnits) The total number of capacity units consumed by the operation.
ConsumedCapacity	withGlobalSecondaryIndexes(java.util.Map<java.lang.String,Capacity> globalSecondaryIndexes) The amount of throughput consumed on each global index affected by the operation.
ConsumedCapacity	withLocalSecondaryIndexes(java.util.Map<java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.util.Map<java.lang.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(java.util.Map<java.lang.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(java.util.Map<java.lang.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(java.lang.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 java.util.Map<java.lang.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(java.util.Map<java.lang.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(java.util.Map<java.lang.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(java.lang.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 java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object