aws_sdk_sns/operation/set_endpoint_attributes/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::set_endpoint_attributes::_set_endpoint_attributes_output::SetEndpointAttributesOutputBuilder;
3
4pub use crate::operation::set_endpoint_attributes::_set_endpoint_attributes_input::SetEndpointAttributesInputBuilder;
5
6impl crate::operation::set_endpoint_attributes::builders::SetEndpointAttributesInputBuilder {
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::set_endpoint_attributes::SetEndpointAttributesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::set_endpoint_attributes::SetEndpointAttributesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.set_endpoint_attributes();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `SetEndpointAttributes`.
24///
25/// <p>Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see <a href="https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html">Using Amazon SNS Mobile Push Notifications</a>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct SetEndpointAttributesFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::set_endpoint_attributes::builders::SetEndpointAttributesInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::set_endpoint_attributes::SetEndpointAttributesOutput,
35        crate::operation::set_endpoint_attributes::SetEndpointAttributesError,
36    > for SetEndpointAttributesFluentBuilder
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::set_endpoint_attributes::SetEndpointAttributesOutput,
44            crate::operation::set_endpoint_attributes::SetEndpointAttributesError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl SetEndpointAttributesFluentBuilder {
51    /// Creates a new `SetEndpointAttributesFluentBuilder`.
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 SetEndpointAttributes as a reference.
60    pub fn as_input(&self) -> &crate::operation::set_endpoint_attributes::builders::SetEndpointAttributesInputBuilder {
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::set_endpoint_attributes::SetEndpointAttributesOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::set_endpoint_attributes::SetEndpointAttributesError,
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::set_endpoint_attributes::SetEndpointAttributes::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::set_endpoint_attributes::SetEndpointAttributes::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::set_endpoint_attributes::SetEndpointAttributesOutput,
97        crate::operation::set_endpoint_attributes::SetEndpointAttributesError,
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>EndpointArn used for <code>SetEndpointAttributes</code> action.</p>
112    pub fn endpoint_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.endpoint_arn(input.into());
114        self
115    }
116    /// <p>EndpointArn used for <code>SetEndpointAttributes</code> action.</p>
117    pub fn set_endpoint_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_endpoint_arn(input);
119        self
120    }
121    /// <p>EndpointArn used for <code>SetEndpointAttributes</code> action.</p>
122    pub fn get_endpoint_arn(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_endpoint_arn()
124    }
125    ///
126    /// Adds a key-value pair to `Attributes`.
127    ///
128    /// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
129    ///
130    /// <p>A map of the endpoint attributes. Attributes in this map include the following:</p>
131    /// <ul>
132    /// <li>
133    /// <p><code>CustomUserData</code> – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</p></li>
134    /// <li>
135    /// <p><code>Enabled</code> – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.</p></li>
136    /// <li>
137    /// <p><code>Token</code> – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.</p></li>
138    /// </ul>
139    pub fn attributes(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
140        self.inner = self.inner.attributes(k.into(), v.into());
141        self
142    }
143    /// <p>A map of the endpoint attributes. Attributes in this map include the following:</p>
144    /// <ul>
145    /// <li>
146    /// <p><code>CustomUserData</code> – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</p></li>
147    /// <li>
148    /// <p><code>Enabled</code> – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.</p></li>
149    /// <li>
150    /// <p><code>Token</code> – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.</p></li>
151    /// </ul>
152    pub fn set_attributes(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
153        self.inner = self.inner.set_attributes(input);
154        self
155    }
156    /// <p>A map of the endpoint attributes. Attributes in this map include the following:</p>
157    /// <ul>
158    /// <li>
159    /// <p><code>CustomUserData</code> – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</p></li>
160    /// <li>
161    /// <p><code>Enabled</code> – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.</p></li>
162    /// <li>
163    /// <p><code>Token</code> – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.</p></li>
164    /// </ul>
165    pub fn get_attributes(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
166        self.inner.get_attributes()
167    }
168}