1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct BatchExecuteStatementInput {
/// <p>The list of PartiQL statements representing the batch to run.</p>
pub statements: ::std::option::Option<::std::vec::Vec<crate::types::BatchStatementRequest>>,
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
}
impl BatchExecuteStatementInput {
/// <p>The list of PartiQL statements representing the batch to run.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.statements.is_none()`.
pub fn statements(&self) -> &[crate::types::BatchStatementRequest] {
self.statements.as_deref().unwrap_or_default()
}
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub fn return_consumed_capacity(&self) -> ::std::option::Option<&crate::types::ReturnConsumedCapacity> {
self.return_consumed_capacity.as_ref()
}
}
impl BatchExecuteStatementInput {
/// Creates a new builder-style object to manufacture [`BatchExecuteStatementInput`](crate::operation::batch_execute_statement::BatchExecuteStatementInput).
pub fn builder() -> crate::operation::batch_execute_statement::builders::BatchExecuteStatementInputBuilder {
crate::operation::batch_execute_statement::builders::BatchExecuteStatementInputBuilder::default()
}
}
/// A builder for [`BatchExecuteStatementInput`](crate::operation::batch_execute_statement::BatchExecuteStatementInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct BatchExecuteStatementInputBuilder {
pub(crate) statements: ::std::option::Option<::std::vec::Vec<crate::types::BatchStatementRequest>>,
pub(crate) return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
}
impl BatchExecuteStatementInputBuilder {
/// Appends an item to `statements`.
///
/// To override the contents of this collection use [`set_statements`](Self::set_statements).
///
/// <p>The list of PartiQL statements representing the batch to run.</p>
pub fn statements(mut self, input: crate::types::BatchStatementRequest) -> Self {
let mut v = self.statements.unwrap_or_default();
v.push(input);
self.statements = ::std::option::Option::Some(v);
self
}
/// <p>The list of PartiQL statements representing the batch to run.</p>
pub fn set_statements(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::BatchStatementRequest>>) -> Self {
self.statements = input;
self
}
/// <p>The list of PartiQL statements representing the batch to run.</p>
pub fn get_statements(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::BatchStatementRequest>> {
&self.statements
}
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub fn return_consumed_capacity(mut self, input: crate::types::ReturnConsumedCapacity) -> Self {
self.return_consumed_capacity = ::std::option::Option::Some(input);
self
}
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub fn set_return_consumed_capacity(mut self, input: ::std::option::Option<crate::types::ReturnConsumedCapacity>) -> Self {
self.return_consumed_capacity = input;
self
}
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub fn get_return_consumed_capacity(&self) -> &::std::option::Option<crate::types::ReturnConsumedCapacity> {
&self.return_consumed_capacity
}
/// Consumes the builder and constructs a [`BatchExecuteStatementInput`](crate::operation::batch_execute_statement::BatchExecuteStatementInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::batch_execute_statement::BatchExecuteStatementInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::batch_execute_statement::BatchExecuteStatementInput {
statements: self.statements,
return_consumed_capacity: self.return_consumed_capacity,
})
}
}