aws_sdk_pinpoint/operation/update_in_app_template/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_in_app_template::_update_in_app_template_output::UpdateInAppTemplateOutputBuilder;
3
4pub use crate::operation::update_in_app_template::_update_in_app_template_input::UpdateInAppTemplateInputBuilder;
5
6impl crate::operation::update_in_app_template::builders::UpdateInAppTemplateInputBuilder {
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_in_app_template::UpdateInAppTemplateOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_in_app_template::UpdateInAppTemplateError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_in_app_template();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateInAppTemplate`.
24///
25/// <p>Updates an existing message template for messages sent through the in-app message channel.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct UpdateInAppTemplateFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::update_in_app_template::builders::UpdateInAppTemplateInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::update_in_app_template::UpdateInAppTemplateOutput,
35        crate::operation::update_in_app_template::UpdateInAppTemplateError,
36    > for UpdateInAppTemplateFluentBuilder
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_in_app_template::UpdateInAppTemplateOutput,
44            crate::operation::update_in_app_template::UpdateInAppTemplateError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl UpdateInAppTemplateFluentBuilder {
51    /// Creates a new `UpdateInAppTemplateFluentBuilder`.
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 UpdateInAppTemplate as a reference.
60    pub fn as_input(&self) -> &crate::operation::update_in_app_template::builders::UpdateInAppTemplateInputBuilder {
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_in_app_template::UpdateInAppTemplateOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::update_in_app_template::UpdateInAppTemplateError,
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_in_app_template::UpdateInAppTemplate::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::update_in_app_template::UpdateInAppTemplate::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_in_app_template::UpdateInAppTemplateOutput,
97        crate::operation::update_in_app_template::UpdateInAppTemplateError,
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>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p>
112    /// <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
113    pub fn create_new_version(mut self, input: bool) -> Self {
114        self.inner = self.inner.create_new_version(input);
115        self
116    }
117    /// <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p>
118    /// <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
119    pub fn set_create_new_version(mut self, input: ::std::option::Option<bool>) -> Self {
120        self.inner = self.inner.set_create_new_version(input);
121        self
122    }
123    /// <p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p>
124    /// <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>
125    pub fn get_create_new_version(&self) -> &::std::option::Option<bool> {
126        self.inner.get_create_new_version()
127    }
128    /// <p>InApp Template Request.</p>
129    pub fn in_app_template_request(mut self, input: crate::types::InAppTemplateRequest) -> Self {
130        self.inner = self.inner.in_app_template_request(input);
131        self
132    }
133    /// <p>InApp Template Request.</p>
134    pub fn set_in_app_template_request(mut self, input: ::std::option::Option<crate::types::InAppTemplateRequest>) -> Self {
135        self.inner = self.inner.set_in_app_template_request(input);
136        self
137    }
138    /// <p>InApp Template Request.</p>
139    pub fn get_in_app_template_request(&self) -> &::std::option::Option<crate::types::InAppTemplateRequest> {
140        self.inner.get_in_app_template_request()
141    }
142    /// <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
143    pub fn template_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
144        self.inner = self.inner.template_name(input.into());
145        self
146    }
147    /// <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
148    pub fn set_template_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
149        self.inner = self.inner.set_template_name(input);
150        self
151    }
152    /// <p>The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.</p>
153    pub fn get_template_name(&self) -> &::std::option::Option<::std::string::String> {
154        self.inner.get_template_name()
155    }
156    /// <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
157    /// <link linkend="templates-template-name-template-type-versions">Template Versions resource.</p>
158    /// <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p>
159    /// <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p>
160    /// <ul>
161    /// <li>
162    /// <p>For a get operation, retrieves information about the active version of the template.</p></li>
163    /// <li>
164    /// <p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li>
165    /// <li>
166    /// <p>For a delete operation, deletes the template, including all versions of the template.</p></li>
167    /// </ul>
168    pub fn version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
169        self.inner = self.inner.version(input.into());
170        self
171    }
172    /// <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
173    /// <link linkend="templates-template-name-template-type-versions">Template Versions resource.</p>
174    /// <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p>
175    /// <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p>
176    /// <ul>
177    /// <li>
178    /// <p>For a get operation, retrieves information about the active version of the template.</p></li>
179    /// <li>
180    /// <p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li>
181    /// <li>
182    /// <p>For a delete operation, deletes the template, including all versions of the template.</p></li>
183    /// </ul>
184    pub fn set_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
185        self.inner = self.inner.set_version(input);
186        self
187    }
188    /// <p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the
189    /// <link linkend="templates-template-name-template-type-versions">Template Versions resource.</p>
190    /// <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p>
191    /// <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p>
192    /// <ul>
193    /// <li>
194    /// <p>For a get operation, retrieves information about the active version of the template.</p></li>
195    /// <li>
196    /// <p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li>
197    /// <li>
198    /// <p>For a delete operation, deletes the template, including all versions of the template.</p></li>
199    /// </ul>
200    pub fn get_version(&self) -> &::std::option::Option<::std::string::String> {
201        self.inner.get_version()
202    }
203}