aws_sdk_sagemaker/operation/list_cluster_events/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_cluster_events::_list_cluster_events_output::ListClusterEventsOutputBuilder;
3
4pub use crate::operation::list_cluster_events::_list_cluster_events_input::ListClusterEventsInputBuilder;
5
6impl crate::operation::list_cluster_events::builders::ListClusterEventsInputBuilder {
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_cluster_events::ListClusterEventsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_cluster_events::ListClusterEventsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_cluster_events();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListClusterEvents`.
24///
25/// <p>Retrieves a list of event summaries for a specified HyperPod cluster. The operation supports filtering, sorting, and pagination of results. This functionality is only supported when the <code>NodeProvisioningMode</code> is set to <code>Continuous</code>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct ListClusterEventsFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::list_cluster_events::builders::ListClusterEventsInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::list_cluster_events::ListClusterEventsOutput,
35        crate::operation::list_cluster_events::ListClusterEventsError,
36    > for ListClusterEventsFluentBuilder
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_cluster_events::ListClusterEventsOutput,
44            crate::operation::list_cluster_events::ListClusterEventsError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl ListClusterEventsFluentBuilder {
51    /// Creates a new `ListClusterEventsFluentBuilder`.
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 ListClusterEvents as a reference.
60    pub fn as_input(&self) -> &crate::operation::list_cluster_events::builders::ListClusterEventsInputBuilder {
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_cluster_events::ListClusterEventsOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::list_cluster_events::ListClusterEventsError,
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_cluster_events::ListClusterEvents::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::list_cluster_events::ListClusterEvents::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_cluster_events::ListClusterEventsOutput,
97        crate::operation::list_cluster_events::ListClusterEventsError,
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_cluster_events::paginator::ListClusterEventsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114    pub fn into_paginator(self) -> crate::operation::list_cluster_events::paginator::ListClusterEventsPaginator {
115        crate::operation::list_cluster_events::paginator::ListClusterEventsPaginator::new(self.handle, self.inner)
116    }
117    /// <p>The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.</p>
118    pub fn cluster_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.cluster_name(input.into());
120        self
121    }
122    /// <p>The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.</p>
123    pub fn set_cluster_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_cluster_name(input);
125        self
126    }
127    /// <p>The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.</p>
128    pub fn get_cluster_name(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_cluster_name()
130    }
131    /// <p>The name of the instance group to filter events. If specified, only events related to this instance group are returned.</p>
132    pub fn instance_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
133        self.inner = self.inner.instance_group_name(input.into());
134        self
135    }
136    /// <p>The name of the instance group to filter events. If specified, only events related to this instance group are returned.</p>
137    pub fn set_instance_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
138        self.inner = self.inner.set_instance_group_name(input);
139        self
140    }
141    /// <p>The name of the instance group to filter events. If specified, only events related to this instance group are returned.</p>
142    pub fn get_instance_group_name(&self) -> &::std::option::Option<::std::string::String> {
143        self.inner.get_instance_group_name()
144    }
145    /// <p>The EC2 instance ID to filter events. If specified, only events related to this instance are returned.</p>
146    pub fn node_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
147        self.inner = self.inner.node_id(input.into());
148        self
149    }
150    /// <p>The EC2 instance ID to filter events. If specified, only events related to this instance are returned.</p>
151    pub fn set_node_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
152        self.inner = self.inner.set_node_id(input);
153        self
154    }
155    /// <p>The EC2 instance ID to filter events. If specified, only events related to this instance are returned.</p>
156    pub fn get_node_id(&self) -> &::std::option::Option<::std::string::String> {
157        self.inner.get_node_id()
158    }
159    /// <p>The start of the time range for filtering events. Only events that occurred after this time are included in the results.</p>
160    pub fn event_time_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
161        self.inner = self.inner.event_time_after(input);
162        self
163    }
164    /// <p>The start of the time range for filtering events. Only events that occurred after this time are included in the results.</p>
165    pub fn set_event_time_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
166        self.inner = self.inner.set_event_time_after(input);
167        self
168    }
169    /// <p>The start of the time range for filtering events. Only events that occurred after this time are included in the results.</p>
170    pub fn get_event_time_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
171        self.inner.get_event_time_after()
172    }
173    /// <p>The end of the time range for filtering events. Only events that occurred before this time are included in the results.</p>
174    pub fn event_time_before(mut self, input: ::aws_smithy_types::DateTime) -> Self {
175        self.inner = self.inner.event_time_before(input);
176        self
177    }
178    /// <p>The end of the time range for filtering events. Only events that occurred before this time are included in the results.</p>
179    pub fn set_event_time_before(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
180        self.inner = self.inner.set_event_time_before(input);
181        self
182    }
183    /// <p>The end of the time range for filtering events. Only events that occurred before this time are included in the results.</p>
184    pub fn get_event_time_before(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
185        self.inner.get_event_time_before()
186    }
187    /// <p>The field to use for sorting the event list. Currently, the only supported value is <code>EventTime</code>.</p>
188    pub fn sort_by(mut self, input: crate::types::EventSortBy) -> Self {
189        self.inner = self.inner.sort_by(input);
190        self
191    }
192    /// <p>The field to use for sorting the event list. Currently, the only supported value is <code>EventTime</code>.</p>
193    pub fn set_sort_by(mut self, input: ::std::option::Option<crate::types::EventSortBy>) -> Self {
194        self.inner = self.inner.set_sort_by(input);
195        self
196    }
197    /// <p>The field to use for sorting the event list. Currently, the only supported value is <code>EventTime</code>.</p>
198    pub fn get_sort_by(&self) -> &::std::option::Option<crate::types::EventSortBy> {
199        self.inner.get_sort_by()
200    }
201    /// <p>The order in which to sort the results. Valid values are <code>Ascending</code> or <code>Descending</code> (the default is <code>Descending</code>).</p>
202    pub fn sort_order(mut self, input: crate::types::SortOrder) -> Self {
203        self.inner = self.inner.sort_order(input);
204        self
205    }
206    /// <p>The order in which to sort the results. Valid values are <code>Ascending</code> or <code>Descending</code> (the default is <code>Descending</code>).</p>
207    pub fn set_sort_order(mut self, input: ::std::option::Option<crate::types::SortOrder>) -> Self {
208        self.inner = self.inner.set_sort_order(input);
209        self
210    }
211    /// <p>The order in which to sort the results. Valid values are <code>Ascending</code> or <code>Descending</code> (the default is <code>Descending</code>).</p>
212    pub fn get_sort_order(&self) -> &::std::option::Option<crate::types::SortOrder> {
213        self.inner.get_sort_order()
214    }
215    /// <p>The type of resource for which to filter events. Valid values are <code>Cluster</code>, <code>InstanceGroup</code>, or <code>Instance</code>.</p>
216    pub fn resource_type(mut self, input: crate::types::ClusterEventResourceType) -> Self {
217        self.inner = self.inner.resource_type(input);
218        self
219    }
220    /// <p>The type of resource for which to filter events. Valid values are <code>Cluster</code>, <code>InstanceGroup</code>, or <code>Instance</code>.</p>
221    pub fn set_resource_type(mut self, input: ::std::option::Option<crate::types::ClusterEventResourceType>) -> Self {
222        self.inner = self.inner.set_resource_type(input);
223        self
224    }
225    /// <p>The type of resource for which to filter events. Valid values are <code>Cluster</code>, <code>InstanceGroup</code>, or <code>Instance</code>.</p>
226    pub fn get_resource_type(&self) -> &::std::option::Option<crate::types::ClusterEventResourceType> {
227        self.inner.get_resource_type()
228    }
229    /// <p>The maximum number of events to return in the response. Valid range is 1 to 100.</p>
230    pub fn max_results(mut self, input: i32) -> Self {
231        self.inner = self.inner.max_results(input);
232        self
233    }
234    /// <p>The maximum number of events to return in the response. Valid range is 1 to 100.</p>
235    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
236        self.inner = self.inner.set_max_results(input);
237        self
238    }
239    /// <p>The maximum number of events to return in the response. Valid range is 1 to 100.</p>
240    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
241        self.inner.get_max_results()
242    }
243    /// <p>A token to retrieve the next set of results. This token is obtained from the output of a previous <code>ListClusterEvents</code> call.</p>
244    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
245        self.inner = self.inner.next_token(input.into());
246        self
247    }
248    /// <p>A token to retrieve the next set of results. This token is obtained from the output of a previous <code>ListClusterEvents</code> call.</p>
249    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
250        self.inner = self.inner.set_next_token(input);
251        self
252    }
253    /// <p>A token to retrieve the next set of results. This token is obtained from the output of a previous <code>ListClusterEvents</code> call.</p>
254    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
255        self.inner.get_next_token()
256    }
257}
aws_sdk_sagemaker/operation/list_cluster_events/builders.rs

aws_sdk_sagemaker/operation/list_cluster_events/
builders.rs
