aws_sdk_keyspacesstreams/operation/list_streams/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_streams::_list_streams_output::ListStreamsOutputBuilder;
3
4pub use crate::operation::list_streams::_list_streams_input::ListStreamsInputBuilder;
5
6impl crate::operation::list_streams::builders::ListStreamsInputBuilder {
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::list_streams::ListStreamsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_streams::ListStreamsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_streams();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListStreams`.
24///
25/// <p>Returns a list of all data capture streams associated with your Amazon Keyspaces account or for a specific keyspace or table. The response includes information such as stream ARNs, table associations, creation timestamps, and current status. This operation helps you discover and manage all active data streams in your Amazon Keyspaces environment.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct ListStreamsFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::list_streams::builders::ListStreamsInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::list_streams::ListStreamsOutput,
35        crate::operation::list_streams::ListStreamsError,
36    > for ListStreamsFluentBuilder
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::list_streams::ListStreamsOutput,
44            crate::operation::list_streams::ListStreamsError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl ListStreamsFluentBuilder {
51    /// Creates a new `ListStreamsFluentBuilder`.
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 ListStreams as a reference.
60    pub fn as_input(&self) -> &crate::operation::list_streams::builders::ListStreamsInputBuilder {
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::list_streams::ListStreamsOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::list_streams::ListStreamsError,
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::list_streams::ListStreams::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::list_streams::ListStreams::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::list_streams::ListStreamsOutput,
97        crate::operation::list_streams::ListStreamsError,
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    /// Create a paginator for this request
112    ///
113    /// Paginators are used by calling [`send().await`](crate::operation::list_streams::paginator::ListStreamsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::list_streams::paginator::ListStreamsPaginator {
115        crate::operation::list_streams::paginator::ListStreamsPaginator::new(self.handle, self.inner)
116    }
117    /// <p>The name of the keyspace for which to list streams. If specified, only streams associated with tables in this keyspace are returned. If omitted, streams from all keyspaces are included in the results.</p>
118    pub fn keyspace_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.keyspace_name(input.into());
120        self
121    }
122    /// <p>The name of the keyspace for which to list streams. If specified, only streams associated with tables in this keyspace are returned. If omitted, streams from all keyspaces are included in the results.</p>
123    pub fn set_keyspace_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_keyspace_name(input);
125        self
126    }
127    /// <p>The name of the keyspace for which to list streams. If specified, only streams associated with tables in this keyspace are returned. If omitted, streams from all keyspaces are included in the results.</p>
128    pub fn get_keyspace_name(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_keyspace_name()
130    }
131    /// <p>The name of the table for which to list streams. Must be used together with <code>keyspaceName</code>. If specified, only streams associated with this specific table are returned.</p>
132    pub fn table_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.table_name(input.into());
134        self
135    }
136    /// <p>The name of the table for which to list streams. Must be used together with <code>keyspaceName</code>. If specified, only streams associated with this specific table are returned.</p>
137    pub fn set_table_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_table_name(input);
139        self
140    }
141    /// <p>The name of the table for which to list streams. Must be used together with <code>keyspaceName</code>. If specified, only streams associated with this specific table are returned.</p>
142    pub fn get_table_name(&self) -> &::std::option::Option<::std::string::String> {
143        self.inner.get_table_name()
144    }
145    /// <p>The maximum number of streams to return in a single <code>ListStreams</code> request. Default value is 100. The minimum value is 1 and the maximum value is 100.</p>
146    pub fn max_results(mut self, input: i32) -> Self {
147        self.inner = self.inner.max_results(input);
148        self
149    }
150    /// <p>The maximum number of streams to return in a single <code>ListStreams</code> request. Default value is 100. The minimum value is 1 and the maximum value is 100.</p>
151    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
152        self.inner = self.inner.set_max_results(input);
153        self
154    }
155    /// <p>The maximum number of streams to return in a single <code>ListStreams</code> request. Default value is 100. The minimum value is 1 and the maximum value is 100.</p>
156    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
157        self.inner.get_max_results()
158    }
159    /// <p>An optional pagination token provided by a previous <code>ListStreams</code> operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>maxResults</code>.</p>
160    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
161        self.inner = self.inner.next_token(input.into());
162        self
163    }
164    /// <p>An optional pagination token provided by a previous <code>ListStreams</code> operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>maxResults</code>.</p>
165    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
166        self.inner = self.inner.set_next_token(input);
167        self
168    }
169    /// <p>An optional pagination token provided by a previous <code>ListStreams</code> operation. If this parameter is specified, the response includes only records beyond the token, up to the value specified by <code>maxResults</code>.</p>
170    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
171        self.inner.get_next_token()
172    }
173}
aws_sdk_keyspacesstreams/operation/list_streams/builders.rs

aws_sdk_keyspacesstreams/operation/list_streams/
builders.rs
