Struct aws_sdk_dynamodb::operation::execute_statement::builders::ExecuteStatementInputBuilder

#[non_exhaustive]
pub struct ExecuteStatementInputBuilder { /* private fields */ }

A builder for ExecuteStatementInput.

Implementations

impl ExecuteStatementInputBuilder

pub fn statement(self, input: impl Into<String>) -> Self

The PartiQL statement representing the operation to run.

This field is required.

pub fn set_statement(self, input: Option<String>) -> Self

The PartiQL statement representing the operation to run.

pub fn get_statement(&self) -> &Option<String>

The PartiQL statement representing the operation to run.

pub fn parameters(self, input: AttributeValue) -> Self

Appends an item to parameters.

To override the contents of this collection use set_parameters.

The parameters for the PartiQL statement, if any.

pub fn set_parameters(self, input: Option<Vec<AttributeValue>>) -> Self

The parameters for the PartiQL statement, if any.

pub fn get_parameters(&self) -> &Option<Vec<AttributeValue>>

The parameters for the PartiQL statement, if any.

pub fn consistent_read(self, input: bool) -> Self

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

pub fn set_consistent_read(self, input: Option<bool>) -> Self

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

pub fn get_consistent_read(&self) -> &Option<bool>

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

pub fn next_token(self, input: impl Into<String>) -> Self

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

pub fn set_next_token(self, input: Option<String>) -> Self

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

pub fn get_next_token(&self) -> &Option<String>

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

pub fn return_consumed_capacity(self, input: ReturnConsumedCapacity) -> Self

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

pub fn set_return_consumed_capacity( self, input: Option<ReturnConsumedCapacity> ) -> Self

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

pub fn get_return_consumed_capacity(&self) -> &Option<ReturnConsumedCapacity>

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

pub fn limit(self, input: i32) -> Self

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.

pub fn set_limit(self, input: Option<i32>) -> Self

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.

pub fn get_limit(&self) -> &Option<i32>

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.

pub fn return_values_on_condition_check_failure( self, input: ReturnValuesOnConditionCheckFailure ) -> Self

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.

pub fn set_return_values_on_condition_check_failure( self, input: Option<ReturnValuesOnConditionCheckFailure> ) -> Self

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.

pub fn get_return_values_on_condition_check_failure( &self ) -> &Option<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.

pub fn build(self) -> Result<ExecuteStatementInput, BuildError>

Consumes the builder and constructs a ExecuteStatementInput.

impl ExecuteStatementInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<ExecuteStatementOutput, SdkError<ExecuteStatementError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ExecuteStatementInputBuilder

fn clone(&self) -> ExecuteStatementInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExecuteStatementInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExecuteStatementInputBuilder

fn default() -> ExecuteStatementInputBuilder

Returns the “default value” for a type.

impl PartialEq for ExecuteStatementInputBuilder

fn eq(&self, other: &ExecuteStatementInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExecuteStatementInputBuilder