/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { /** *

A summary of the metrics of a trial component.

See Also:

AWS * API Reference

*/ class TrialComponentMetricSummary { public: AWS_SAGEMAKER_API TrialComponentMetricSummary(); AWS_SAGEMAKER_API TrialComponentMetricSummary(Aws::Utils::Json::JsonView jsonValue); AWS_SAGEMAKER_API TrialComponentMetricSummary& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_SAGEMAKER_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the metric.

*/ inline const Aws::String& GetMetricName() const{ return m_metricName; } /** *

The name of the metric.

*/ inline bool MetricNameHasBeenSet() const { return m_metricNameHasBeenSet; } /** *

The name of the metric.

*/ inline void SetMetricName(const Aws::String& value) { m_metricNameHasBeenSet = true; m_metricName = value; } /** *

The name of the metric.

*/ inline void SetMetricName(Aws::String&& value) { m_metricNameHasBeenSet = true; m_metricName = std::move(value); } /** *

The name of the metric.

*/ inline void SetMetricName(const char* value) { m_metricNameHasBeenSet = true; m_metricName.assign(value); } /** *

The name of the metric.

*/ inline TrialComponentMetricSummary& WithMetricName(const Aws::String& value) { SetMetricName(value); return *this;} /** *

The name of the metric.

*/ inline TrialComponentMetricSummary& WithMetricName(Aws::String&& value) { SetMetricName(std::move(value)); return *this;} /** *

The name of the metric.

*/ inline TrialComponentMetricSummary& WithMetricName(const char* value) { SetMetricName(value); return *this;} /** *

The Amazon Resource Name (ARN) of the source.

*/ inline const Aws::String& GetSourceArn() const{ return m_sourceArn; } /** *

The Amazon Resource Name (ARN) of the source.

*/ inline bool SourceArnHasBeenSet() const { return m_sourceArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the source.

*/ inline void SetSourceArn(const Aws::String& value) { m_sourceArnHasBeenSet = true; m_sourceArn = value; } /** *

The Amazon Resource Name (ARN) of the source.

*/ inline void SetSourceArn(Aws::String&& value) { m_sourceArnHasBeenSet = true; m_sourceArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the source.

*/ inline void SetSourceArn(const char* value) { m_sourceArnHasBeenSet = true; m_sourceArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the source.

*/ inline TrialComponentMetricSummary& WithSourceArn(const Aws::String& value) { SetSourceArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the source.

*/ inline TrialComponentMetricSummary& WithSourceArn(Aws::String&& value) { SetSourceArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the source.

*/ inline TrialComponentMetricSummary& WithSourceArn(const char* value) { SetSourceArn(value); return *this;} /** *

When the metric was last updated.

*/ inline const Aws::Utils::DateTime& GetTimeStamp() const{ return m_timeStamp; } /** *

When the metric was last updated.

*/ inline bool TimeStampHasBeenSet() const { return m_timeStampHasBeenSet; } /** *

When the metric was last updated.

*/ inline void SetTimeStamp(const Aws::Utils::DateTime& value) { m_timeStampHasBeenSet = true; m_timeStamp = value; } /** *

When the metric was last updated.

*/ inline void SetTimeStamp(Aws::Utils::DateTime&& value) { m_timeStampHasBeenSet = true; m_timeStamp = std::move(value); } /** *

When the metric was last updated.

*/ inline TrialComponentMetricSummary& WithTimeStamp(const Aws::Utils::DateTime& value) { SetTimeStamp(value); return *this;} /** *

When the metric was last updated.

*/ inline TrialComponentMetricSummary& WithTimeStamp(Aws::Utils::DateTime&& value) { SetTimeStamp(std::move(value)); return *this;} /** *

The maximum value of the metric.

*/ inline double GetMax() const{ return m_max; } /** *

The maximum value of the metric.

*/ inline bool MaxHasBeenSet() const { return m_maxHasBeenSet; } /** *

The maximum value of the metric.

*/ inline void SetMax(double value) { m_maxHasBeenSet = true; m_max = value; } /** *

The maximum value of the metric.

*/ inline TrialComponentMetricSummary& WithMax(double value) { SetMax(value); return *this;} /** *

The minimum value of the metric.

*/ inline double GetMin() const{ return m_min; } /** *

The minimum value of the metric.

*/ inline bool MinHasBeenSet() const { return m_minHasBeenSet; } /** *

The minimum value of the metric.

*/ inline void SetMin(double value) { m_minHasBeenSet = true; m_min = value; } /** *

The minimum value of the metric.

*/ inline TrialComponentMetricSummary& WithMin(double value) { SetMin(value); return *this;} /** *

The most recent value of the metric.

*/ inline double GetLast() const{ return m_last; } /** *

The most recent value of the metric.

*/ inline bool LastHasBeenSet() const { return m_lastHasBeenSet; } /** *

The most recent value of the metric.

*/ inline void SetLast(double value) { m_lastHasBeenSet = true; m_last = value; } /** *

The most recent value of the metric.

*/ inline TrialComponentMetricSummary& WithLast(double value) { SetLast(value); return *this;} /** *

The number of samples used to generate the metric.

*/ inline int GetCount() const{ return m_count; } /** *

The number of samples used to generate the metric.

*/ inline bool CountHasBeenSet() const { return m_countHasBeenSet; } /** *

The number of samples used to generate the metric.

*/ inline void SetCount(int value) { m_countHasBeenSet = true; m_count = value; } /** *

The number of samples used to generate the metric.

*/ inline TrialComponentMetricSummary& WithCount(int value) { SetCount(value); return *this;} /** *

The average value of the metric.

*/ inline double GetAvg() const{ return m_avg; } /** *

The average value of the metric.

*/ inline bool AvgHasBeenSet() const { return m_avgHasBeenSet; } /** *

The average value of the metric.

*/ inline void SetAvg(double value) { m_avgHasBeenSet = true; m_avg = value; } /** *

The average value of the metric.

*/ inline TrialComponentMetricSummary& WithAvg(double value) { SetAvg(value); return *this;} /** *

The standard deviation of the metric.

*/ inline double GetStdDev() const{ return m_stdDev; } /** *

The standard deviation of the metric.

*/ inline bool StdDevHasBeenSet() const { return m_stdDevHasBeenSet; } /** *

The standard deviation of the metric.

*/ inline void SetStdDev(double value) { m_stdDevHasBeenSet = true; m_stdDev = value; } /** *

The standard deviation of the metric.

*/ inline TrialComponentMetricSummary& WithStdDev(double value) { SetStdDev(value); return *this;} private: Aws::String m_metricName; bool m_metricNameHasBeenSet = false; Aws::String m_sourceArn; bool m_sourceArnHasBeenSet = false; Aws::Utils::DateTime m_timeStamp; bool m_timeStampHasBeenSet = false; double m_max; bool m_maxHasBeenSet = false; double m_min; bool m_minHasBeenSet = false; double m_last; bool m_lastHasBeenSet = false; int m_count; bool m_countHasBeenSet = false; double m_avg; bool m_avgHasBeenSet = false; double m_stdDev; bool m_stdDevHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws