aws_sdk_redshiftdata/operation/list_statements/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_statements::_list_statements_output::ListStatementsOutputBuilder;
3
4pub use crate::operation::list_statements::_list_statements_input::ListStatementsInputBuilder;
5
6impl crate::operation::list_statements::builders::ListStatementsInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::list_statements::ListStatementsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_statements::ListStatementsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_statements();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListStatements`.
24///
25/// <p>List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.</p>
26/// <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListStatementsFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::list_statements::builders::ListStatementsInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::list_statements::ListStatementsOutput,
36        crate::operation::list_statements::ListStatementsError,
37    > for ListStatementsFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::list_statements::ListStatementsOutput,
45            crate::operation::list_statements::ListStatementsError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl ListStatementsFluentBuilder {
52    /// Creates a new `ListStatementsFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the ListStatements as a reference.
61    pub fn as_input(&self) -> &crate::operation::list_statements::builders::ListStatementsInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::list_statements::ListStatementsOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::list_statements::ListStatementsError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::list_statements::ListStatements::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::list_statements::ListStatements::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::list_statements::ListStatementsOutput,
98        crate::operation::list_statements::ListStatementsError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::list_statements::paginator::ListStatementsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::list_statements::paginator::ListStatementsPaginator {
116        crate::operation::list_statements::paginator::ListStatementsPaginator::new(self.handle, self.inner)
117    }
118    /// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.</p>
119    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
120        self.inner = self.inner.next_token(input.into());
121        self
122    }
123    /// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.</p>
124    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125        self.inner = self.inner.set_next_token(input);
126        self
127    }
128    /// <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.</p>
129    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
130        self.inner.get_next_token()
131    }
132    /// <p>The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results.</p>
133    pub fn max_results(mut self, input: i32) -> Self {
134        self.inner = self.inner.max_results(input);
135        self
136    }
137    /// <p>The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results.</p>
138    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
139        self.inner = self.inner.set_max_results(input);
140        self
141    }
142    /// <p>The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then <code>NextToken</code> is returned to page through the results.</p>
143    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
144        self.inner.get_max_results()
145    }
146    /// <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.</p>
147    pub fn statement_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
148        self.inner = self.inner.statement_name(input.into());
149        self
150    }
151    /// <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.</p>
152    pub fn set_statement_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
153        self.inner = self.inner.set_statement_name(input);
154        self
155    }
156    /// <p>The name of the SQL statement specified as input to <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.</p>
157    pub fn get_statement_name(&self) -> &::std::option::Option<::std::string::String> {
158        self.inner.get_statement_name()
159    }
160    /// <p>The status of the SQL statement to list. Status values are defined as follows:</p>
161    /// <ul>
162    /// <li>
163    /// <p>ABORTED - The query run was stopped by the user.</p></li>
164    /// <li>
165    /// <p>ALL - A status value that includes all query statuses. This value can be used to filter results.</p></li>
166    /// <li>
167    /// <p>FAILED - The query run failed.</p></li>
168    /// <li>
169    /// <p>FINISHED - The query has finished running.</p></li>
170    /// <li>
171    /// <p>PICKED - The query has been chosen to be run.</p></li>
172    /// <li>
173    /// <p>STARTED - The query run has started.</p></li>
174    /// <li>
175    /// <p>SUBMITTED - The query was submitted, but not yet processed.</p></li>
176    /// </ul>
177    pub fn status(mut self, input: crate::types::StatusString) -> Self {
178        self.inner = self.inner.status(input);
179        self
180    }
181    /// <p>The status of the SQL statement to list. Status values are defined as follows:</p>
182    /// <ul>
183    /// <li>
184    /// <p>ABORTED - The query run was stopped by the user.</p></li>
185    /// <li>
186    /// <p>ALL - A status value that includes all query statuses. This value can be used to filter results.</p></li>
187    /// <li>
188    /// <p>FAILED - The query run failed.</p></li>
189    /// <li>
190    /// <p>FINISHED - The query has finished running.</p></li>
191    /// <li>
192    /// <p>PICKED - The query has been chosen to be run.</p></li>
193    /// <li>
194    /// <p>STARTED - The query run has started.</p></li>
195    /// <li>
196    /// <p>SUBMITTED - The query was submitted, but not yet processed.</p></li>
197    /// </ul>
198    pub fn set_status(mut self, input: ::std::option::Option<crate::types::StatusString>) -> Self {
199        self.inner = self.inner.set_status(input);
200        self
201    }
202    /// <p>The status of the SQL statement to list. Status values are defined as follows:</p>
203    /// <ul>
204    /// <li>
205    /// <p>ABORTED - The query run was stopped by the user.</p></li>
206    /// <li>
207    /// <p>ALL - A status value that includes all query statuses. This value can be used to filter results.</p></li>
208    /// <li>
209    /// <p>FAILED - The query run failed.</p></li>
210    /// <li>
211    /// <p>FINISHED - The query has finished running.</p></li>
212    /// <li>
213    /// <p>PICKED - The query has been chosen to be run.</p></li>
214    /// <li>
215    /// <p>STARTED - The query run has started.</p></li>
216    /// <li>
217    /// <p>SUBMITTED - The query was submitted, but not yet processed.</p></li>
218    /// </ul>
219    pub fn get_status(&self) -> &::std::option::Option<crate::types::StatusString> {
220        self.inner.get_status()
221    }
222    /// <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.</p>
223    pub fn role_level(mut self, input: bool) -> Self {
224        self.inner = self.inner.role_level(input);
225        self
226    }
227    /// <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.</p>
228    pub fn set_role_level(mut self, input: ::std::option::Option<bool>) -> Self {
229        self.inner = self.inner.set_role_level(input);
230        self
231    }
232    /// <p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.</p>
233    pub fn get_role_level(&self) -> &::std::option::Option<bool> {
234        self.inner.get_role_level()
235    }
236}