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

Class BatchStatementRequest

    • Method Detail

      • statement

        public final String statement()

        A valid PartiQL statement.

        Returns:
        A valid PartiQL statement.

      • hasParameters

        public final boolean hasParameters()
        For responses, this returns true if the service returned a value for the Parameters 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.

      • parameters

        public final List<AttributeValue> parameters()

        The parameters associated with a PartiQL statement in the batch request.

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

        Returns:
        The parameters associated with a PartiQL statement in the batch request.

      • consistentRead

        public final Boolean consistentRead()

        The read consistency of the PartiQL batch request.

        Returns:
        The read consistency of the PartiQL batch request.

      • returnValuesOnConditionCheckFailure

        public final ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure()

        An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a condition check.

        There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

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

        Returns:
        An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a condition check.

        There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

        See Also:
        ReturnValuesOnConditionCheckFailure

      • returnValuesOnConditionCheckFailureAsString

        public final String returnValuesOnConditionCheckFailureAsString()

        An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a condition check.

        There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

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

        Returns:
        An optional parameter that returns the item attributes for a PartiQL batch request operation that failed a condition check.

        There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

        See Also:
        ReturnValuesOnConditionCheckFailure

      • hashCode

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

      • equals

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

      • 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)