ConditionCheck (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConditionCheck
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConditionCheck()

Constructors
Constructor and Description
`ConditionCheck()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConditionCheck`	`addExpressionAttributeNamesEntry(String key, String value)` Add a single ExpressionAttributeNames entry
`ConditionCheck`	`addExpressionAttributeValuesEntry(String key, AttributeValue value)` Add a single ExpressionAttributeValues entry
`ConditionCheck`	`addKeyEntry(String key, AttributeValue value)` Add a single Key entry
`ConditionCheck`	`clearExpressionAttributeNamesEntries()` Removes all the entries added into ExpressionAttributeNames.
`ConditionCheck`	`clearExpressionAttributeValuesEntries()` Removes all the entries added into ExpressionAttributeValues.
`ConditionCheck`	`clearKeyEntries()` Removes all the entries added into Key.
`ConditionCheck`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getConditionExpression()` A condition that must be satisfied in order for a conditional update to succeed.
`Map<String,String>`	`getExpressionAttributeNames()` One or more substitution tokens for attribute names in an expression.
`Map<String,AttributeValue>`	`getExpressionAttributeValues()` One or more values that can be substituted in an expression.
`Map<String,AttributeValue>`	`getKey()` The primary key of the item to be checked.
`String`	`getReturnValuesOnConditionCheckFailure()` Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `ConditionCheck` condition fails.
`String`	`getTableName()` Name of the table for the check item request.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setConditionExpression(String conditionExpression)` A condition that must be satisfied in order for a conditional update to succeed.
`void`	`setExpressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`void`	`setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`void`	`setKey(Map<String,AttributeValue> key)` The primary key of the item to be checked.
`void`	`setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)` Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `ConditionCheck` condition fails.
`void`	`setTableName(String tableName)` Name of the table for the check item request.
`String`	`toString()` Returns a string representation of this object.
`ConditionCheck`	`withConditionExpression(String conditionExpression)` A condition that must be satisfied in order for a conditional update to succeed.
`ConditionCheck`	`withExpressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`ConditionCheck`	`withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`ConditionCheck`	`withKey(Map<String,AttributeValue> key)` The primary key of the item to be checked.
`ConditionCheck`	`withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)` Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `ConditionCheck` condition fails.
`ConditionCheck`	`withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)` Use `ReturnValuesOnConditionCheckFailure` to get the item attributes if the `ConditionCheck` condition fails.
`ConditionCheck`	`withTableName(String tableName)` Name of the table for the check item request.

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

- Constructor Detail
  - ConditionCheck
```
public ConditionCheck()
```
- Method Detail
  - getKey
```
public Map<String,AttributeValue> getKey()
```
    The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
    
    Returns:
    
    The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
  - setKey
```
public void setKey(Map<String,AttributeValue> key)
```
    The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
    
    Parameters:
    
    key - The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
  - withKey
```
public ConditionCheck withKey(Map<String,AttributeValue> key)
```
    The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
    
    Parameters:
    
    key - The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addKeyEntry
```
public ConditionCheck addKeyEntry(String key,
                                  AttributeValue value)
```
    Add a single Key entry
    
    See Also:
    
    withKey(java.util.Map<java.lang.String, com.amazonaws.services.dynamodbv2.model.AttributeValue>)
  - clearKeyEntries
```
public ConditionCheck clearKeyEntries()
```
    Removes all the entries added into Key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTableName
```
public void setTableName(String tableName)
```
    Name of the table for the check item request.
    
    Parameters:
    
    tableName - Name of the table for the check item request.
  - getTableName
```
public String getTableName()
```
    Name of the table for the check item request.
    
    Returns:
    
    Name of the table for the check item request.
  - withTableName
```
public ConditionCheck withTableName(String tableName)
```
    Name of the table for the check item request.
    
    Parameters:
    
    tableName - Name of the table for the check item request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConditionExpression
```
public void setConditionExpression(String conditionExpression)
```
    A condition that must be satisfied in order for a conditional update to succeed.
    
    Parameters:
    
    conditionExpression - A condition that must be satisfied in order for a conditional update to succeed.
  - getConditionExpression
```
public String getConditionExpression()
```
    A condition that must be satisfied in order for a conditional update to succeed.
    
    Returns:
    
    A condition that must be satisfied in order for a conditional update to succeed.
  - withConditionExpression
```
public ConditionCheck withConditionExpression(String conditionExpression)
```
    A condition that must be satisfied in order for a conditional update to succeed.
    
    Parameters:
    
    conditionExpression - A condition that must be satisfied in order for a conditional update to succeed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExpressionAttributeNames
```
public Map<String,String> getExpressionAttributeNames()
```
    One or more substitution tokens for attribute names in an expression.
    
    Returns:
    
    One or more substitution tokens for attribute names in an expression.
  - setExpressionAttributeNames
```
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution tokens for attribute names in an expression.
    
    Parameters:
    
    expressionAttributeNames - One or more substitution tokens for attribute names in an expression.
  - withExpressionAttributeNames
```
public ConditionCheck withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution tokens for attribute names in an expression.
    
    Parameters:
    
    expressionAttributeNames - One or more substitution tokens for attribute names in an expression.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addExpressionAttributeNamesEntry
```
public ConditionCheck addExpressionAttributeNamesEntry(String key,
                                                       String value)
```
    Add a single ExpressionAttributeNames entry
    
    See Also:
    
    withExpressionAttributeNames(java.util.Map<java.lang.String, java.lang.String>)
  - clearExpressionAttributeNamesEntries
```
public ConditionCheck clearExpressionAttributeNamesEntries()
```
    Removes all the entries added into ExpressionAttributeNames.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExpressionAttributeValues
```
public Map<String,AttributeValue> getExpressionAttributeValues()
```
    One or more values that can be substituted in an expression.
    
    Returns:
    
    One or more values that can be substituted in an expression.
  - setExpressionAttributeValues
```
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
```
    One or more values that can be substituted in an expression.
    
    Parameters:
    
    expressionAttributeValues - One or more values that can be substituted in an expression.
  - withExpressionAttributeValues
```
public ConditionCheck withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
```
    One or more values that can be substituted in an expression.
    
    Parameters:
    
    expressionAttributeValues - One or more values that can be substituted in an expression.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addExpressionAttributeValuesEntry
```
public ConditionCheck addExpressionAttributeValuesEntry(String key,
                                                        AttributeValue value)
```
    Add a single ExpressionAttributeValues entry
    
    See Also:
    
    withExpressionAttributeValues(java.util.Map<java.lang.String, com.amazonaws.services.dynamodbv2.model.AttributeValue>)
  - clearExpressionAttributeValuesEntries
```
public ConditionCheck clearExpressionAttributeValuesEntries()
```
    Removes all the entries added into ExpressionAttributeValues.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReturnValuesOnConditionCheckFailure
```
public void setReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
```
    Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
    
    Parameters:
    
    returnValuesOnConditionCheckFailure - Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
    
    See Also:
    
    ReturnValuesOnConditionCheckFailure
  - getReturnValuesOnConditionCheckFailure
```
public String getReturnValuesOnConditionCheckFailure()
```
    Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
    
    Returns:
    
    Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
    
    See Also:
    
    ReturnValuesOnConditionCheckFailure
  - withReturnValuesOnConditionCheckFailure
```
public ConditionCheck withReturnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
```
    Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
    
    Parameters:
    
    returnValuesOnConditionCheckFailure - Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnValuesOnConditionCheckFailure
  - withReturnValuesOnConditionCheckFailure
```
public ConditionCheck withReturnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
```
    Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
    
    Parameters:
    
    returnValuesOnConditionCheckFailure - Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnValuesOnConditionCheckFailure
  - toString
```
public 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
    
    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 ConditionCheck 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 ConditionCheck

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConditionCheck

Method Detail

getKey

setKey

withKey

addKeyEntry

clearKeyEntries

setTableName

getTableName

withTableName

setConditionExpression

getConditionExpression

withConditionExpression

getExpressionAttributeNames

setExpressionAttributeNames

withExpressionAttributeNames

addExpressionAttributeNamesEntry

clearExpressionAttributeNamesEntries

getExpressionAttributeValues

setExpressionAttributeValues

withExpressionAttributeValues

addExpressionAttributeValuesEntry

clearExpressionAttributeValuesEntries

setReturnValuesOnConditionCheckFailure

getReturnValuesOnConditionCheckFailure

withReturnValuesOnConditionCheckFailure

withReturnValuesOnConditionCheckFailure

toString

equals

hashCode

clone

marshall