Class PutItemRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.querydataplane.model.QueryDataPlaneRequest
software.amazon.awssdk.services.querydataplane.model.PutItemRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutItemRequest.Builder,PutItemRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutItemRequest extends QueryDataPlaneRequest implements ToCopyableBuilder<PutItemRequest.Builder,PutItemRequest>

  • Method Details

    • tableName

      public final String tableName()
      Returns the value of the TableName property for this object.
      Returns:
      The value of the TableName property for this object.

    • hasItem

      public final boolean hasItem()
      For responses, this returns true if the service returned a value for the Item property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • item

      public final Map<String,AttributeValue> item()
      Returns the value of the Item property for this object.

      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.

      Returns:
      The value of the Item property for this object.

    • hasExpected

      public final boolean hasExpected()
      For responses, this returns true if the service returned a value for the Expected property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • expected

      public final Map<String,ExpectedAttributeValue> expected()
      Returns the value of the Expected property for this object.

      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 hasExpected() method.

      Returns:
      The value of the Expected property for this object.

    • returnValues

      public final String returnValues()
      Returns the value of the ReturnValues property for this object.
      Returns:
      The value of the ReturnValues property for this object.

    • returnConsumedCapacity

      public final String returnConsumedCapacity()
      Returns the value of the ReturnConsumedCapacity property for this object.
      Returns:
      The value of the ReturnConsumedCapacity property for this object.

    • returnItemCollectionMetrics

      public final String returnItemCollectionMetrics()
      Returns the value of the ReturnItemCollectionMetrics property for this object.
      Returns:
      The value of the ReturnItemCollectionMetrics property for this object.

    • conditionalOperator

      public final String conditionalOperator()
      Returns the value of the ConditionalOperator property for this object.
      Returns:
      The value of the ConditionalOperator property for this object.

    • conditionExpression

      public final String conditionExpression()
      Returns the value of the ConditionExpression property for this object.
      Returns:
      The value of the ConditionExpression property for this object.

    • hasExpressionAttributeNames

      public final boolean hasExpressionAttributeNames()
      For responses, this returns true if the service returned a value for the ExpressionAttributeNames property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • expressionAttributeNames

      public final Map<String,String> expressionAttributeNames()
      Returns the value of the ExpressionAttributeNames property for this object.

      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.

      Returns:
      The value of the ExpressionAttributeNames property for this object.

    • hasExpressionAttributeValues

      public final boolean hasExpressionAttributeValues()
      For responses, this returns true if the service returned a value for the ExpressionAttributeValues property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • expressionAttributeValues

      public final Map<String,AttributeValue> expressionAttributeValues()
      Returns the value of the ExpressionAttributeValues property for this object.

      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.

      Returns:
      The value of the ExpressionAttributeValues property for this object.

    • returnValuesOnConditionCheckFailure

      public final String returnValuesOnConditionCheckFailure()
      Returns the value of the ReturnValuesOnConditionCheckFailure property for this object.
      Returns:
      The value of the ReturnValuesOnConditionCheckFailure property for this object.

    • toBuilder

      public PutItemRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutItemRequest.Builder,PutItemRequest>
      Specified by:
      toBuilder in class QueryDataPlaneRequest
      Returns:
      a builder for type T

    • builder

      public static PutItemRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutItemRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.