@Generated(value="software.amazon.awssdk:codegen") public final class Put extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Put.Builder,Put>
Represents a request to perform a PutItem
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
Put.Builder |
Modifier and Type | Method and Description |
---|---|
static Put.Builder |
builder() |
String |
conditionExpression()
A condition that must be satisfied in order for a conditional update to succeed.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Map<String,String> |
expressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
Map<String,AttributeValue> |
expressionAttributeValues()
One or more values that can be substituted in an expression.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasExpressionAttributeNames()
For responses, this returns true if the service returned a value for the ExpressionAttributeNames property.
|
boolean |
hasExpressionAttributeValues()
For responses, this returns true if the service returned a value for the ExpressionAttributeValues property.
|
int |
hashCode() |
boolean |
hasItem()
For responses, this returns true if the service returned a value for the Item property.
|
Map<String,AttributeValue> |
item()
A map of attribute name to attribute values, representing the primary key of the item to be written by
PutItem . |
ReturnValuesOnConditionCheckFailure |
returnValuesOnConditionCheckFailure()
Use
ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition
fails. |
String |
returnValuesOnConditionCheckFailureAsString()
Use
ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition
fails. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends Put.Builder> |
serializableBuilderClass() |
String |
tableName()
Name of the table in which to write the item.
|
Put.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasItem()
isEmpty()
method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final Map<String,AttributeValue> item()
A map of attribute name to attribute values, representing the primary key of the item to be written by
PutItem
. All of the table's primary key attributes must be specified, and their data types must
match those of the table's key schema. If any attributes are present in the item that are part of an index key
schema for the table, their types must match the index key schema.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasItem()
method.
PutItem
. All of the table's primary key attributes must be specified, and their data types
must match those of the table's key schema. If any attributes are present in the item that are part of an
index key schema for the table, their types must match the index key schema.public final String tableName()
Name of the table in which to write the item.
public final String conditionExpression()
A condition that must be satisfied in order for a conditional update to succeed.
public final boolean hasExpressionAttributeNames()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final Map<String,String> expressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasExpressionAttributeNames()
method.
public final boolean hasExpressionAttributeValues()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final Map<String,AttributeValue> expressionAttributeValues()
One or more values that can be substituted in an expression.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasExpressionAttributeValues()
method.
public final ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure()
Use ReturnValuesOnConditionCheckFailure
to get the item attributes if the Put
condition
fails. For ReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.
If the service returns an enum value that is not available in the current SDK version,
returnValuesOnConditionCheckFailure
will return
ReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from returnValuesOnConditionCheckFailureAsString()
.
ReturnValuesOnConditionCheckFailure
to get the item attributes if the Put
condition fails. For ReturnValuesOnConditionCheckFailure
, the valid values are: NONE and
ALL_OLD.ReturnValuesOnConditionCheckFailure
public final String returnValuesOnConditionCheckFailureAsString()
Use ReturnValuesOnConditionCheckFailure
to get the item attributes if the Put
condition
fails. For ReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.
If the service returns an enum value that is not available in the current SDK version,
returnValuesOnConditionCheckFailure
will return
ReturnValuesOnConditionCheckFailure.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from returnValuesOnConditionCheckFailureAsString()
.
ReturnValuesOnConditionCheckFailure
to get the item attributes if the Put
condition fails. For ReturnValuesOnConditionCheckFailure
, the valid values are: NONE and
ALL_OLD.ReturnValuesOnConditionCheckFailure
public Put.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<Put.Builder,Put>
public static Put.Builder builder()
public static Class<? extends Put.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.