aws_sdk_sagemaker/operation/update_experiment/
_update_experiment_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct UpdateExperimentInput {
6    /// <p>The name of the experiment to update.</p>
7    pub experiment_name: ::std::option::Option<::std::string::String>,
8    /// <p>The name of the experiment as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
9    pub display_name: ::std::option::Option<::std::string::String>,
10    /// <p>The description of the experiment.</p>
11    pub description: ::std::option::Option<::std::string::String>,
12}
13impl UpdateExperimentInput {
14    /// <p>The name of the experiment to update.</p>
15    pub fn experiment_name(&self) -> ::std::option::Option<&str> {
16        self.experiment_name.as_deref()
17    }
18    /// <p>The name of the experiment as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
19    pub fn display_name(&self) -> ::std::option::Option<&str> {
20        self.display_name.as_deref()
21    }
22    /// <p>The description of the experiment.</p>
23    pub fn description(&self) -> ::std::option::Option<&str> {
24        self.description.as_deref()
25    }
26}
27impl UpdateExperimentInput {
28    /// Creates a new builder-style object to manufacture [`UpdateExperimentInput`](crate::operation::update_experiment::UpdateExperimentInput).
29    pub fn builder() -> crate::operation::update_experiment::builders::UpdateExperimentInputBuilder {
30        crate::operation::update_experiment::builders::UpdateExperimentInputBuilder::default()
31    }
32}
33
34/// A builder for [`UpdateExperimentInput`](crate::operation::update_experiment::UpdateExperimentInput).
35#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
36#[non_exhaustive]
37pub struct UpdateExperimentInputBuilder {
38    pub(crate) experiment_name: ::std::option::Option<::std::string::String>,
39    pub(crate) display_name: ::std::option::Option<::std::string::String>,
40    pub(crate) description: ::std::option::Option<::std::string::String>,
41}
42impl UpdateExperimentInputBuilder {
43    /// <p>The name of the experiment to update.</p>
44    /// This field is required.
45    pub fn experiment_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
46        self.experiment_name = ::std::option::Option::Some(input.into());
47        self
48    }
49    /// <p>The name of the experiment to update.</p>
50    pub fn set_experiment_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
51        self.experiment_name = input;
52        self
53    }
54    /// <p>The name of the experiment to update.</p>
55    pub fn get_experiment_name(&self) -> &::std::option::Option<::std::string::String> {
56        &self.experiment_name
57    }
58    /// <p>The name of the experiment as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
59    pub fn display_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
60        self.display_name = ::std::option::Option::Some(input.into());
61        self
62    }
63    /// <p>The name of the experiment as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
64    pub fn set_display_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
65        self.display_name = input;
66        self
67    }
68    /// <p>The name of the experiment as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
69    pub fn get_display_name(&self) -> &::std::option::Option<::std::string::String> {
70        &self.display_name
71    }
72    /// <p>The description of the experiment.</p>
73    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
74        self.description = ::std::option::Option::Some(input.into());
75        self
76    }
77    /// <p>The description of the experiment.</p>
78    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
79        self.description = input;
80        self
81    }
82    /// <p>The description of the experiment.</p>
83    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
84        &self.description
85    }
86    /// Consumes the builder and constructs a [`UpdateExperimentInput`](crate::operation::update_experiment::UpdateExperimentInput).
87    pub fn build(
88        self,
89    ) -> ::std::result::Result<crate::operation::update_experiment::UpdateExperimentInput, ::aws_smithy_types::error::operation::BuildError> {
90        ::std::result::Result::Ok(crate::operation::update_experiment::UpdateExperimentInput {
91            experiment_name: self.experiment_name,
92            display_name: self.display_name,
93            description: self.description,
94        })
95    }
96}