aws_sdk_cloudtrail/operation/describe_query/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_query::_describe_query_output::DescribeQueryOutputBuilder;
3
4pub use crate::operation::describe_query::_describe_query_input::DescribeQueryInputBuilder;
5
6impl crate::operation::describe_query::builders::DescribeQueryInputBuilder {
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::describe_query::DescribeQueryOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_query::DescribeQueryError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_query();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeQuery`.
24///
25/// <p>Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.</p>
26/// <p>You must specify either <code>QueryId</code> or <code>QueryAlias</code>. Specifying the <code>QueryAlias</code> parameter returns information about the last query run for the alias. You can provide <code>RefreshId</code> along with <code>QueryAlias</code> to view the query results of a dashboard query for the specified <code>RefreshId</code>.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DescribeQueryFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::describe_query::builders::DescribeQueryInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::describe_query::DescribeQueryOutput,
36        crate::operation::describe_query::DescribeQueryError,
37    > for DescribeQueryFluentBuilder
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::describe_query::DescribeQueryOutput,
45            crate::operation::describe_query::DescribeQueryError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl DescribeQueryFluentBuilder {
52    /// Creates a new `DescribeQueryFluentBuilder`.
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 DescribeQuery as a reference.
61    pub fn as_input(&self) -> &crate::operation::describe_query::builders::DescribeQueryInputBuilder {
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::describe_query::DescribeQueryOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::describe_query::DescribeQueryError,
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::describe_query::DescribeQuery::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::describe_query::DescribeQuery::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::describe_query::DescribeQueryOutput,
98        crate::operation::describe_query::DescribeQueryError,
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    /// <p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.</p>
113    #[deprecated(note = "EventDataStore is no longer required by DescribeQueryRequest")]
114    pub fn event_data_store(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.event_data_store(input.into());
116        self
117    }
118    /// <p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.</p>
119    #[deprecated(note = "EventDataStore is no longer required by DescribeQueryRequest")]
120    pub fn set_event_data_store(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121        self.inner = self.inner.set_event_data_store(input);
122        self
123    }
124    /// <p>The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.</p>
125    #[deprecated(note = "EventDataStore is no longer required by DescribeQueryRequest")]
126    pub fn get_event_data_store(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_event_data_store()
128    }
129    /// <p>The query ID.</p>
130    pub fn query_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
131        self.inner = self.inner.query_id(input.into());
132        self
133    }
134    /// <p>The query ID.</p>
135    pub fn set_query_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
136        self.inner = self.inner.set_query_id(input);
137        self
138    }
139    /// <p>The query ID.</p>
140    pub fn get_query_id(&self) -> &::std::option::Option<::std::string::String> {
141        self.inner.get_query_id()
142    }
143    /// <p>The alias that identifies a query template.</p>
144    pub fn query_alias(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
145        self.inner = self.inner.query_alias(input.into());
146        self
147    }
148    /// <p>The alias that identifies a query template.</p>
149    pub fn set_query_alias(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
150        self.inner = self.inner.set_query_alias(input);
151        self
152    }
153    /// <p>The alias that identifies a query template.</p>
154    pub fn get_query_alias(&self) -> &::std::option::Option<::std::string::String> {
155        self.inner.get_query_alias()
156    }
157    /// <p>The ID of the dashboard refresh.</p>
158    pub fn refresh_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
159        self.inner = self.inner.refresh_id(input.into());
160        self
161    }
162    /// <p>The ID of the dashboard refresh.</p>
163    pub fn set_refresh_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
164        self.inner = self.inner.set_refresh_id(input);
165        self
166    }
167    /// <p>The ID of the dashboard refresh.</p>
168    pub fn get_refresh_id(&self) -> &::std::option::Option<::std::string::String> {
169        self.inner.get_refresh_id()
170    }
171    /// <p>The account ID of the event data store owner.</p>
172    pub fn event_data_store_owner_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
173        self.inner = self.inner.event_data_store_owner_account_id(input.into());
174        self
175    }
176    /// <p>The account ID of the event data store owner.</p>
177    pub fn set_event_data_store_owner_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
178        self.inner = self.inner.set_event_data_store_owner_account_id(input);
179        self
180    }
181    /// <p>The account ID of the event data store owner.</p>
182    pub fn get_event_data_store_owner_account_id(&self) -> &::std::option::Option<::std::string::String> {
183        self.inner.get_event_data_store_owner_account_id()
184    }
185}
aws_sdk_cloudtrail/operation/describe_query/builders.rs

aws_sdk_cloudtrail/operation/describe_query/
builders.rs
