aws_sdk_quicksight/operation/update_analysis/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_analysis::_update_analysis_output::UpdateAnalysisOutputBuilder;
3
4pub use crate::operation::update_analysis::_update_analysis_input::UpdateAnalysisInputBuilder;
5
6impl crate::operation::update_analysis::builders::UpdateAnalysisInputBuilder {
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::update_analysis::UpdateAnalysisOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_analysis::UpdateAnalysisError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_analysis();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateAnalysis`.
24///
25/// <p>Updates an analysis in Amazon QuickSight</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct UpdateAnalysisFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::update_analysis::builders::UpdateAnalysisInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::update_analysis::UpdateAnalysisOutput,
35        crate::operation::update_analysis::UpdateAnalysisError,
36    > for UpdateAnalysisFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::update_analysis::UpdateAnalysisOutput,
44            crate::operation::update_analysis::UpdateAnalysisError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl UpdateAnalysisFluentBuilder {
51    /// Creates a new `UpdateAnalysisFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the UpdateAnalysis as a reference.
60    pub fn as_input(&self) -> &crate::operation::update_analysis::builders::UpdateAnalysisInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::update_analysis::UpdateAnalysisOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::update_analysis::UpdateAnalysisError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::update_analysis::UpdateAnalysis::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::update_analysis::UpdateAnalysis::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::update_analysis::UpdateAnalysisOutput,
97        crate::operation::update_analysis::UpdateAnalysisError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The ID of the Amazon Web Services account that contains the analysis that you're updating.</p>
112    pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.aws_account_id(input.into());
114        self
115    }
116    /// <p>The ID of the Amazon Web Services account that contains the analysis that you're updating.</p>
117    pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_aws_account_id(input);
119        self
120    }
121    /// <p>The ID of the Amazon Web Services account that contains the analysis that you're updating.</p>
122    pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_aws_account_id()
124    }
125    /// <p>The ID for the analysis that you're updating. This ID displays in the URL of the analysis.</p>
126    pub fn analysis_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.analysis_id(input.into());
128        self
129    }
130    /// <p>The ID for the analysis that you're updating. This ID displays in the URL of the analysis.</p>
131    pub fn set_analysis_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_analysis_id(input);
133        self
134    }
135    /// <p>The ID for the analysis that you're updating. This ID displays in the URL of the analysis.</p>
136    pub fn get_analysis_id(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_analysis_id()
138    }
139    /// <p>A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.</p>
140    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.name(input.into());
142        self
143    }
144    /// <p>A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.</p>
145    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_name(input);
147        self
148    }
149    /// <p>A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.</p>
150    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_name()
152    }
153    /// <p>The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.</p>
154    pub fn parameters(mut self, input: crate::types::Parameters) -> Self {
155        self.inner = self.inner.parameters(input);
156        self
157    }
158    /// <p>The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.</p>
159    pub fn set_parameters(mut self, input: ::std::option::Option<crate::types::Parameters>) -> Self {
160        self.inner = self.inner.set_parameters(input);
161        self
162    }
163    /// <p>The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.</p>
164    pub fn get_parameters(&self) -> &::std::option::Option<crate::types::Parameters> {
165        self.inner.get_parameters()
166    }
167    /// <p>A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.</p>
168    pub fn source_entity(mut self, input: crate::types::AnalysisSourceEntity) -> Self {
169        self.inner = self.inner.source_entity(input);
170        self
171    }
172    /// <p>A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.</p>
173    pub fn set_source_entity(mut self, input: ::std::option::Option<crate::types::AnalysisSourceEntity>) -> Self {
174        self.inner = self.inner.set_source_entity(input);
175        self
176    }
177    /// <p>A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.</p>
178    pub fn get_source_entity(&self) -> &::std::option::Option<crate::types::AnalysisSourceEntity> {
179        self.inner.get_source_entity()
180    }
181    /// <p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.</p>
182    pub fn theme_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
183        self.inner = self.inner.theme_arn(input.into());
184        self
185    }
186    /// <p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.</p>
187    pub fn set_theme_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
188        self.inner = self.inner.set_theme_arn(input);
189        self
190    }
191    /// <p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.</p>
192    pub fn get_theme_arn(&self) -> &::std::option::Option<::std::string::String> {
193        self.inner.get_theme_arn()
194    }
195    /// <p>The definition of an analysis.</p>
196    /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
197    pub fn definition(mut self, input: crate::types::AnalysisDefinition) -> Self {
198        self.inner = self.inner.definition(input);
199        self
200    }
201    /// <p>The definition of an analysis.</p>
202    /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
203    pub fn set_definition(mut self, input: ::std::option::Option<crate::types::AnalysisDefinition>) -> Self {
204        self.inner = self.inner.set_definition(input);
205        self
206    }
207    /// <p>The definition of an analysis.</p>
208    /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
209    pub fn get_definition(&self) -> &::std::option::Option<crate::types::AnalysisDefinition> {
210        self.inner.get_definition()
211    }
212    /// <p>The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.</p>
213    pub fn validation_strategy(mut self, input: crate::types::ValidationStrategy) -> Self {
214        self.inner = self.inner.validation_strategy(input);
215        self
216    }
217    /// <p>The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.</p>
218    pub fn set_validation_strategy(mut self, input: ::std::option::Option<crate::types::ValidationStrategy>) -> Self {
219        self.inner = self.inner.set_validation_strategy(input);
220        self
221    }
222    /// <p>The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.</p>
223    pub fn get_validation_strategy(&self) -> &::std::option::Option<crate::types::ValidationStrategy> {
224        self.inner.get_validation_strategy()
225    }
226}