aws_sdk_kinesis/operation/deregister_stream_consumer/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::deregister_stream_consumer::_deregister_stream_consumer_output::DeregisterStreamConsumerOutputBuilder;
3
4pub use crate::operation::deregister_stream_consumer::_deregister_stream_consumer_input::DeregisterStreamConsumerInputBuilder;
5
6impl crate::operation::deregister_stream_consumer::builders::DeregisterStreamConsumerInputBuilder {
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::deregister_stream_consumer::DeregisterStreamConsumerOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::deregister_stream_consumer::DeregisterStreamConsumerError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.deregister_stream_consumer();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DeregisterStreamConsumer`.
24///
25/// <p>To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the <code>ListStreamConsumers</code> operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.</p>
26/// <p>This operation has a limit of five transactions per second per stream.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DeregisterStreamConsumerFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::deregister_stream_consumer::builders::DeregisterStreamConsumerInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::deregister_stream_consumer::DeregisterStreamConsumerOutput,
36        crate::operation::deregister_stream_consumer::DeregisterStreamConsumerError,
37    > for DeregisterStreamConsumerFluentBuilder
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::deregister_stream_consumer::DeregisterStreamConsumerOutput,
45            crate::operation::deregister_stream_consumer::DeregisterStreamConsumerError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl DeregisterStreamConsumerFluentBuilder {
52    /// Creates a new `DeregisterStreamConsumerFluentBuilder`.
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 DeregisterStreamConsumer as a reference.
61    pub fn as_input(&self) -> &crate::operation::deregister_stream_consumer::builders::DeregisterStreamConsumerInputBuilder {
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::deregister_stream_consumer::DeregisterStreamConsumerOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::deregister_stream_consumer::DeregisterStreamConsumerError,
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::deregister_stream_consumer::DeregisterStreamConsumer::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::deregister_stream_consumer::DeregisterStreamConsumer::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::deregister_stream_consumer::DeregisterStreamConsumerOutput,
98        crate::operation::deregister_stream_consumer::DeregisterStreamConsumerError,
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 of the Kinesis data stream that the consumer is registered with. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
113    pub fn stream_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.stream_arn(input.into());
115        self
116    }
117    /// <p>The ARN of the Kinesis data stream that the consumer is registered with. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
118    pub fn set_stream_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_stream_arn(input);
120        self
121    }
122    /// <p>The ARN of the Kinesis data stream that the consumer is registered with. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>
123    pub fn get_stream_arn(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_stream_arn()
125    }
126    /// <p>The name that you gave to the consumer.</p>
127    pub fn consumer_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.consumer_name(input.into());
129        self
130    }
131    /// <p>The name that you gave to the consumer.</p>
132    pub fn set_consumer_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_consumer_name(input);
134        self
135    }
136    /// <p>The name that you gave to the consumer.</p>
137    pub fn get_consumer_name(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_consumer_name()
139    }
140    /// <p>The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.</p>
141    pub fn consumer_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
142        self.inner = self.inner.consumer_arn(input.into());
143        self
144    }
145    /// <p>The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.</p>
146    pub fn set_consumer_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
147        self.inner = self.inner.set_consumer_arn(input);
148        self
149    }
150    /// <p>The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.</p>
151    pub fn get_consumer_arn(&self) -> &::std::option::Option<::std::string::String> {
152        self.inner.get_consumer_arn()
153    }
154}
aws_sdk_kinesis/operation/deregister_stream_consumer/builders.rs

aws_sdk_kinesis/operation/deregister_stream_consumer/
builders.rs
