aws_sdk_databasemigration/operation/describe_events/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_events::_describe_events_output::DescribeEventsOutputBuilder;
3
4pub use crate::operation::describe_events::_describe_events_input::DescribeEventsInputBuilder;
5
6impl crate::operation::describe_events::builders::DescribeEventsInputBuilder {
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::describe_events::DescribeEventsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_events::DescribeEventsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_events();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeEvents`.
24///
25/// <p>Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html">Working with Events and Notifications</a> in the <i>Database Migration Service User Guide.</i></p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeEventsFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::describe_events::builders::DescribeEventsInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::describe_events::DescribeEventsOutput,
35        crate::operation::describe_events::DescribeEventsError,
36    > for DescribeEventsFluentBuilder
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::describe_events::DescribeEventsOutput,
44            crate::operation::describe_events::DescribeEventsError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl DescribeEventsFluentBuilder {
51    /// Creates a new `DescribeEventsFluentBuilder`.
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 DescribeEvents as a reference.
60    pub fn as_input(&self) -> &crate::operation::describe_events::builders::DescribeEventsInputBuilder {
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::describe_events::DescribeEventsOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::describe_events::DescribeEventsError,
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::describe_events::DescribeEvents::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::describe_events::DescribeEvents::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::describe_events::DescribeEventsOutput,
97        crate::operation::describe_events::DescribeEventsError,
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::describe_events::paginator::DescribeEventsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::describe_events::paginator::DescribeEventsPaginator {
115        crate::operation::describe_events::paginator::DescribeEventsPaginator::new(self.handle, self.inner)
116    }
117    /// <p>The identifier of an event source.</p>
118    pub fn source_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.source_identifier(input.into());
120        self
121    }
122    /// <p>The identifier of an event source.</p>
123    pub fn set_source_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_source_identifier(input);
125        self
126    }
127    /// <p>The identifier of an event source.</p>
128    pub fn get_source_identifier(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_source_identifier()
130    }
131    /// <p>The type of DMS resource that generates events.</p>
132    /// <p>Valid values: replication-instance | replication-task</p>
133    pub fn source_type(mut self, input: crate::types::SourceType) -> Self {
134        self.inner = self.inner.source_type(input);
135        self
136    }
137    /// <p>The type of DMS resource that generates events.</p>
138    /// <p>Valid values: replication-instance | replication-task</p>
139    pub fn set_source_type(mut self, input: ::std::option::Option<crate::types::SourceType>) -> Self {
140        self.inner = self.inner.set_source_type(input);
141        self
142    }
143    /// <p>The type of DMS resource that generates events.</p>
144    /// <p>Valid values: replication-instance | replication-task</p>
145    pub fn get_source_type(&self) -> &::std::option::Option<crate::types::SourceType> {
146        self.inner.get_source_type()
147    }
148    /// <p>The start time for the events to be listed.</p>
149    pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
150        self.inner = self.inner.start_time(input);
151        self
152    }
153    /// <p>The start time for the events to be listed.</p>
154    pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
155        self.inner = self.inner.set_start_time(input);
156        self
157    }
158    /// <p>The start time for the events to be listed.</p>
159    pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
160        self.inner.get_start_time()
161    }
162    /// <p>The end time for the events to be listed.</p>
163    pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
164        self.inner = self.inner.end_time(input);
165        self
166    }
167    /// <p>The end time for the events to be listed.</p>
168    pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
169        self.inner = self.inner.set_end_time(input);
170        self
171    }
172    /// <p>The end time for the events to be listed.</p>
173    pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
174        self.inner.get_end_time()
175    }
176    /// <p>The duration of the events to be listed.</p>
177    pub fn duration(mut self, input: i32) -> Self {
178        self.inner = self.inner.duration(input);
179        self
180    }
181    /// <p>The duration of the events to be listed.</p>
182    pub fn set_duration(mut self, input: ::std::option::Option<i32>) -> Self {
183        self.inner = self.inner.set_duration(input);
184        self
185    }
186    /// <p>The duration of the events to be listed.</p>
187    pub fn get_duration(&self) -> &::std::option::Option<i32> {
188        self.inner.get_duration()
189    }
190    ///
191    /// Appends an item to `EventCategories`.
192    ///
193    /// To override the contents of this collection use [`set_event_categories`](Self::set_event_categories).
194    ///
195    /// <p>A list of event categories for the source type that you've chosen.</p>
196    pub fn event_categories(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
197        self.inner = self.inner.event_categories(input.into());
198        self
199    }
200    /// <p>A list of event categories for the source type that you've chosen.</p>
201    pub fn set_event_categories(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
202        self.inner = self.inner.set_event_categories(input);
203        self
204    }
205    /// <p>A list of event categories for the source type that you've chosen.</p>
206    pub fn get_event_categories(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
207        self.inner.get_event_categories()
208    }
209    ///
210    /// Appends an item to `Filters`.
211    ///
212    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
213    ///
214    /// <p>Filters applied to events. The only valid filter is <code>replication-instance-id</code>.</p>
215    pub fn filters(mut self, input: crate::types::Filter) -> Self {
216        self.inner = self.inner.filters(input);
217        self
218    }
219    /// <p>Filters applied to events. The only valid filter is <code>replication-instance-id</code>.</p>
220    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Filter>>) -> Self {
221        self.inner = self.inner.set_filters(input);
222        self
223    }
224    /// <p>Filters applied to events. The only valid filter is <code>replication-instance-id</code>.</p>
225    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Filter>> {
226        self.inner.get_filters()
227    }
228    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</p>
229    /// <p>Default: 100</p>
230    /// <p>Constraints: Minimum 20, maximum 100.</p>
231    pub fn max_records(mut self, input: i32) -> Self {
232        self.inner = self.inner.max_records(input);
233        self
234    }
235    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</p>
236    /// <p>Default: 100</p>
237    /// <p>Constraints: Minimum 20, maximum 100.</p>
238    pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
239        self.inner = self.inner.set_max_records(input);
240        self
241    }
242    /// <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</p>
243    /// <p>Default: 100</p>
244    /// <p>Constraints: Minimum 20, maximum 100.</p>
245    pub fn get_max_records(&self) -> &::std::option::Option<i32> {
246        self.inner.get_max_records()
247    }
248    /// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
249    pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
250        self.inner = self.inner.marker(input.into());
251        self
252    }
253    /// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
254    pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
255        self.inner = self.inner.set_marker(input);
256        self
257    }
258    /// <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
259    pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
260        self.inner.get_marker()
261    }
262}