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

Interface ExecuteStatementRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>, DynamoDbRequest.Builder, SdkBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ExecuteStatementRequest
public static interface ExecuteStatementRequest.Builder extends DynamoDbRequest.Builder, SdkPojo, CopyableBuilder<ExecuteStatementRequest.Builder,ExecuteStatementRequest>

  • Method Details

    • statement

      ExecuteStatementRequest.Builder statement(String statement)

      The PartiQL statement representing the operation to run.

      Parameters:
      statement - The PartiQL statement representing the operation to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      ExecuteStatementRequest.Builder parameters(Collection<AttributeValue> parameters)

      The parameters for the PartiQL statement, if any.

      Parameters:
      parameters - The parameters for the PartiQL statement, if any.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      ExecuteStatementRequest.Builder parameters(AttributeValue... parameters)

      The parameters for the PartiQL statement, if any.

      Parameters:
      parameters - The parameters for the PartiQL statement, if any.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      ExecuteStatementRequest.Builder parameters(Consumer<AttributeValue.Builder>... parameters)

      The parameters for the PartiQL statement, if any.

      This is a convenience method that creates an instance of the AttributeValue.Builder avoiding the need to create one manually via AttributeValue.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameters(List<AttributeValue>).

      Parameters:
      parameters - a consumer that will call methods on AttributeValue.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • consistentRead

      ExecuteStatementRequest.Builder consistentRead(Boolean consistentRead)

      The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

      Parameters:
      consistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ExecuteStatementRequest.Builder nextToken(String nextToken)

      Set this value to get remaining results, if NextToken was returned in the statement response.

      Parameters:
      nextToken - Set this value to get remaining results, if NextToken was returned in the statement response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • returnConsumedCapacity

      ExecuteStatementRequest.Builder returnConsumedCapacity(String returnConsumedCapacity)
      Sets the value of the ReturnConsumedCapacity property for this object.
      Parameters:
      returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • returnConsumedCapacity

      ExecuteStatementRequest.Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
      Sets the value of the ReturnConsumedCapacity property for this object.
      Parameters:
      returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • limit

      ExecuteStatementRequest.Builder limit(Integer limit)

      The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, along with a key in LastEvaluatedKey to apply in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation.

      Parameters:
      limit - The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, along with a key in LastEvaluatedKey to apply in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • returnValuesOnConditionCheckFailure

      ExecuteStatementRequest.Builder returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)

      An optional parameter that returns the item attributes for an ExecuteStatement 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.

      Parameters:
      returnValuesOnConditionCheckFailure - An optional parameter that returns the item attributes for an ExecuteStatement 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • returnValuesOnConditionCheckFailure

      ExecuteStatementRequest.Builder returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)

      An optional parameter that returns the item attributes for an ExecuteStatement 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.

      Parameters:
      returnValuesOnConditionCheckFailure - An optional parameter that returns the item attributes for an ExecuteStatement 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ExecuteStatementRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ExecuteStatementRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.