aws-sdk-sagemakermetrics 1.113.0

AWS SDK for Amazon SageMaker Metrics Service
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct BatchPutMetricsInput {
    /// <p>The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.</p>
    pub trial_component_name: ::std::option::Option<::std::string::String>,
    /// <p>A list of raw metric values to put.</p>
    pub metric_data: ::std::option::Option<::std::vec::Vec<crate::types::RawMetricData>>,
}
impl BatchPutMetricsInput {
    /// <p>The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.</p>
    pub fn trial_component_name(&self) -> ::std::option::Option<&str> {
        self.trial_component_name.as_deref()
    }
    /// <p>A list of raw metric values to put.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.metric_data.is_none()`.
    pub fn metric_data(&self) -> &[crate::types::RawMetricData] {
        self.metric_data.as_deref().unwrap_or_default()
    }
}
impl BatchPutMetricsInput {
    /// Creates a new builder-style object to manufacture [`BatchPutMetricsInput`](crate::operation::batch_put_metrics::BatchPutMetricsInput).
    pub fn builder() -> crate::operation::batch_put_metrics::builders::BatchPutMetricsInputBuilder {
        crate::operation::batch_put_metrics::builders::BatchPutMetricsInputBuilder::default()
    }
}

/// A builder for [`BatchPutMetricsInput`](crate::operation::batch_put_metrics::BatchPutMetricsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct BatchPutMetricsInputBuilder {
    pub(crate) trial_component_name: ::std::option::Option<::std::string::String>,
    pub(crate) metric_data: ::std::option::Option<::std::vec::Vec<crate::types::RawMetricData>>,
}
impl BatchPutMetricsInputBuilder {
    /// <p>The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.</p>
    /// This field is required.
    pub fn trial_component_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.trial_component_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.</p>
    pub fn set_trial_component_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.trial_component_name = input;
        self
    }
    /// <p>The name of the Trial Component to associate with the metrics. The Trial Component name must be entirely lowercase.</p>
    pub fn get_trial_component_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.trial_component_name
    }
    /// Appends an item to `metric_data`.
    ///
    /// To override the contents of this collection use [`set_metric_data`](Self::set_metric_data).
    ///
    /// <p>A list of raw metric values to put.</p>
    pub fn metric_data(mut self, input: crate::types::RawMetricData) -> Self {
        let mut v = self.metric_data.unwrap_or_default();
        v.push(input);
        self.metric_data = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of raw metric values to put.</p>
    pub fn set_metric_data(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RawMetricData>>) -> Self {
        self.metric_data = input;
        self
    }
    /// <p>A list of raw metric values to put.</p>
    pub fn get_metric_data(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RawMetricData>> {
        &self.metric_data
    }
    /// Consumes the builder and constructs a [`BatchPutMetricsInput`](crate::operation::batch_put_metrics::BatchPutMetricsInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::batch_put_metrics::BatchPutMetricsInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::batch_put_metrics::BatchPutMetricsInput {
            trial_component_name: self.trial_component_name,
            metric_data: self.metric_data,
        })
    }
}