aws_sdk_sagemaker/operation/create_trial/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_trial::_create_trial_output::CreateTrialOutputBuilder;
3
4pub use crate::operation::create_trial::_create_trial_input::CreateTrialInputBuilder;
5
6impl crate::operation::create_trial::builders::CreateTrialInputBuilder {
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::create_trial::CreateTrialOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_trial::CreateTrialError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_trial();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateTrial`.
24///
25/// <p>Creates an SageMaker <i>trial</i>. A trial is a set of steps called <i>trial components</i> that produce a machine learning model. A trial is part of a single SageMaker <i>experiment</i>.</p>
26/// <p>When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.</p>
27/// <p>You can add tags to a trial and then use the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search for the tags.</p>
28/// <p>To get a list of all your trials, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html">ListTrials</a> API. To view a trial's properties, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html">DescribeTrial</a> API. To create a trial component, call the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html">CreateTrialComponent</a> API.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct CreateTrialFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::create_trial::builders::CreateTrialInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::create_trial::CreateTrialOutput,
38        crate::operation::create_trial::CreateTrialError,
39    > for CreateTrialFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::create_trial::CreateTrialOutput,
47            crate::operation::create_trial::CreateTrialError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl CreateTrialFluentBuilder {
54    /// Creates a new `CreateTrialFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the CreateTrial as a reference.
63    pub fn as_input(&self) -> &crate::operation::create_trial::builders::CreateTrialInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::create_trial::CreateTrialOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::create_trial::CreateTrialError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::create_trial::CreateTrial::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::create_trial::CreateTrial::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::create_trial::CreateTrialOutput,
100        crate::operation::create_trial::CreateTrialError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// <p>The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p>
115    pub fn trial_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.inner = self.inner.trial_name(input.into());
117        self
118    }
119    /// <p>The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p>
120    pub fn set_trial_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
121        self.inner = self.inner.set_trial_name(input);
122        self
123    }
124    /// <p>The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p>
125    pub fn get_trial_name(&self) -> &::std::option::Option<::std::string::String> {
126        self.inner.get_trial_name()
127    }
128    /// <p>The name of the trial as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
129    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
130        self.inner = self.inner.display_name(input.into());
131        self
132    }
133    /// <p>The name of the trial as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
134    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
135        self.inner = self.inner.set_display_name(input);
136        self
137    }
138    /// <p>The name of the trial as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
139    pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
140        self.inner.get_display_name()
141    }
142    /// <p>The name of the experiment to associate the trial with.</p>
143    pub fn experiment_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
144        self.inner = self.inner.experiment_name(input.into());
145        self
146    }
147    /// <p>The name of the experiment to associate the trial with.</p>
148    pub fn set_experiment_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
149        self.inner = self.inner.set_experiment_name(input);
150        self
151    }
152    /// <p>The name of the experiment to associate the trial with.</p>
153    pub fn get_experiment_name(&self) -> &::std::option::Option<::std::string::String> {
154        self.inner.get_experiment_name()
155    }
156    /// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
157    pub fn metadata_properties(mut self, input: crate::types::MetadataProperties) -> Self {
158        self.inner = self.inner.metadata_properties(input);
159        self
160    }
161    /// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
162    pub fn set_metadata_properties(mut self, input: ::std::option::Option<crate::types::MetadataProperties>) -> Self {
163        self.inner = self.inner.set_metadata_properties(input);
164        self
165    }
166    /// <p>Metadata properties of the tracking entity, trial, or trial component.</p>
167    pub fn get_metadata_properties(&self) -> &::std::option::Option<crate::types::MetadataProperties> {
168        self.inner.get_metadata_properties()
169    }
170    ///
171    /// Appends an item to `Tags`.
172    ///
173    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
174    ///
175    /// <p>A list of tags to associate with the trial. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>
176    pub fn tags(mut self, input: crate::types::Tag) -> Self {
177        self.inner = self.inner.tags(input);
178        self
179    }
180    /// <p>A list of tags to associate with the trial. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>
181    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
182        self.inner = self.inner.set_tags(input);
183        self
184    }
185    /// <p>A list of tags to associate with the trial. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p>
186    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
187        self.inner.get_tags()
188    }
189}
aws_sdk_sagemaker/operation/create_trial/builders.rs

aws_sdk_sagemaker/operation/create_trial/
builders.rs
