aws_sdk_pinpoint/operation/remove_attributes/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::remove_attributes::_remove_attributes_output::RemoveAttributesOutputBuilder;
3
4pub use crate::operation::remove_attributes::_remove_attributes_input::RemoveAttributesInputBuilder;
5
6impl crate::operation::remove_attributes::builders::RemoveAttributesInputBuilder {
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::remove_attributes::RemoveAttributesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::remove_attributes::RemoveAttributesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.remove_attributes();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `RemoveAttributes`.
24///
25/// <p>Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct RemoveAttributesFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::remove_attributes::builders::RemoveAttributesInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::remove_attributes::RemoveAttributesOutput,
35        crate::operation::remove_attributes::RemoveAttributesError,
36    > for RemoveAttributesFluentBuilder
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::remove_attributes::RemoveAttributesOutput,
44            crate::operation::remove_attributes::RemoveAttributesError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl RemoveAttributesFluentBuilder {
51    /// Creates a new `RemoveAttributesFluentBuilder`.
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 RemoveAttributes as a reference.
60    pub fn as_input(&self) -> &crate::operation::remove_attributes::builders::RemoveAttributesInputBuilder {
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::remove_attributes::RemoveAttributesOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::remove_attributes::RemoveAttributesError,
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::remove_attributes::RemoveAttributes::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::remove_attributes::RemoveAttributes::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::remove_attributes::RemoveAttributesOutput,
97        crate::operation::remove_attributes::RemoveAttributesError,
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 unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
112    pub fn application_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.application_id(input.into());
114        self
115    }
116    /// <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
117    pub fn set_application_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_application_id(input);
119        self
120    }
121    /// <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>
122    pub fn get_application_id(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_application_id()
124    }
125    /// <p>The type of attribute or attributes to remove. Valid values are:</p>
126    /// <ul>
127    /// <li>
128    /// <p>endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.</p></li>
129    /// <li>
130    /// <p>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.</p></li>
131    /// <li>
132    /// <p>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</p></li>
133    /// </ul>
134    pub fn attribute_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.attribute_type(input.into());
136        self
137    }
138    /// <p>The type of attribute or attributes to remove. Valid values are:</p>
139    /// <ul>
140    /// <li>
141    /// <p>endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.</p></li>
142    /// <li>
143    /// <p>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.</p></li>
144    /// <li>
145    /// <p>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</p></li>
146    /// </ul>
147    pub fn set_attribute_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148        self.inner = self.inner.set_attribute_type(input);
149        self
150    }
151    /// <p>The type of attribute or attributes to remove. Valid values are:</p>
152    /// <ul>
153    /// <li>
154    /// <p>endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.</p></li>
155    /// <li>
156    /// <p>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.</p></li>
157    /// <li>
158    /// <p>endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.</p></li>
159    /// </ul>
160    pub fn get_attribute_type(&self) -> &::std::option::Option<::std::string::String> {
161        self.inner.get_attribute_type()
162    }
163    /// <p>Specifies one or more attributes to remove from all the endpoints that are associated with an application.</p>
164    pub fn update_attributes_request(mut self, input: crate::types::UpdateAttributesRequest) -> Self {
165        self.inner = self.inner.update_attributes_request(input);
166        self
167    }
168    /// <p>Specifies one or more attributes to remove from all the endpoints that are associated with an application.</p>
169    pub fn set_update_attributes_request(mut self, input: ::std::option::Option<crate::types::UpdateAttributesRequest>) -> Self {
170        self.inner = self.inner.set_update_attributes_request(input);
171        self
172    }
173    /// <p>Specifies one or more attributes to remove from all the endpoints that are associated with an application.</p>
174    pub fn get_update_attributes_request(&self) -> &::std::option::Option<crate::types::UpdateAttributesRequest> {
175        self.inner.get_update_attributes_request()
176    }
177}
aws_sdk_pinpoint/operation/remove_attributes/builders.rs

aws_sdk_pinpoint/operation/remove_attributes/
builders.rs
