Package software.amazon.awssdk.services.dynamodb.model

Enum ReturnConsumedCapacity

java.lang.Object

java.lang.Enum<ReturnConsumedCapacity>

software.amazon.awssdk.services.dynamodb.model.ReturnConsumedCapacity

All Implemented Interfaces:

Serializable, Comparable<ReturnConsumedCapacity>

@Generated("software.amazon.awssdk:codegen")
public enum ReturnConsumedCapacity
extends Enum<ReturnConsumedCapacity>

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INDEXES
NONE
TOTAL
UNKNOWN_TO_SDK_VERSION

Method Summary

Modifier and Type	Method	Description
static ReturnConsumedCapacity	fromValue(String value)	Use this in place of valueOf to convert the raw string returned by the service into the enum value.
static Set<ReturnConsumedCapacity>	knownValues()	Use this in place of values() to return a Set of all values known to the SDK.
String	toString()
static ReturnConsumedCapacity	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReturnConsumedCapacity[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INDEXES

public static final ReturnConsumedCapacity INDEXES

TOTAL

public static final ReturnConsumedCapacity TOTAL

NONE

public static final ReturnConsumedCapacity NONE

UNKNOWN_TO_SDK_VERSION

public static final ReturnConsumedCapacity UNKNOWN_TO_SDK_VERSION

Method Details

values

public static ReturnConsumedCapacity[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReturnConsumedCapacity valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<ReturnConsumedCapacity>

fromValue

public static ReturnConsumedCapacity fromValue(String value)

Use this in place of valueOf to convert the raw string returned by the service into the enum value.

Parameters:

value - real value

Returns:

ReturnConsumedCapacity corresponding to the value

knownValues

public static Set<ReturnConsumedCapacity> knownValues()

Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.

Returns:

a Set of known ReturnConsumedCapacitys