pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/TrialComponentMetricSummary.h

/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

#pragma once
#include <aws/sagemaker/SageMaker_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/DateTime.h>
#include <utility>

namespace Aws
{
namespace Utils
{
namespace Json
{
  class JsonValue;
  class JsonView;
} // namespace Json
} // namespace Utils
namespace SageMaker
{
namespace Model
{

  /**
   * <p>A summary of the metrics of a trial component.</p><p><h3>See Also:</h3>   <a
   * href="http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TrialComponentMetricSummary">AWS
   * API Reference</a></p>
   */
  class AWS_SAGEMAKER_API TrialComponentMetricSummary
  {
  public:
    TrialComponentMetricSummary();
    TrialComponentMetricSummary(Aws::Utils::Json::JsonView jsonValue);
    TrialComponentMetricSummary& operator=(Aws::Utils::Json::JsonView jsonValue);
    Aws::Utils::Json::JsonValue Jsonize() const;


    /**
     * <p>The name of the metric.</p>
     */
    inline const Aws::String& GetMetricName() const{ return m_metricName; }

    /**
     * <p>The name of the metric.</p>
     */
    inline bool MetricNameHasBeenSet() const { return m_metricNameHasBeenSet; }

    /**
     * <p>The name of the metric.</p>
     */
    inline void SetMetricName(const Aws::String& value) { m_metricNameHasBeenSet = true; m_metricName = value; }

    /**
     * <p>The name of the metric.</p>
     */
    inline void SetMetricName(Aws::String&& value) { m_metricNameHasBeenSet = true; m_metricName = std::move(value); }

    /**
     * <p>The name of the metric.</p>
     */
    inline void SetMetricName(const char* value) { m_metricNameHasBeenSet = true; m_metricName.assign(value); }

    /**
     * <p>The name of the metric.</p>
     */
    inline TrialComponentMetricSummary& WithMetricName(const Aws::String& value) { SetMetricName(value); return *this;}

    /**
     * <p>The name of the metric.</p>
     */
    inline TrialComponentMetricSummary& WithMetricName(Aws::String&& value) { SetMetricName(std::move(value)); return *this;}

    /**
     * <p>The name of the metric.</p>
     */
    inline TrialComponentMetricSummary& WithMetricName(const char* value) { SetMetricName(value); return *this;}


    /**
     * <p>The Amazon Resource Name (ARN) of the source.</p>
     */
    inline const Aws::String& GetSourceArn() const{ return m_sourceArn; }

    /**
     * <p>The Amazon Resource Name (ARN) of the source.</p>
     */
    inline bool SourceArnHasBeenSet() const { return m_sourceArnHasBeenSet; }

    /**
     * <p>The Amazon Resource Name (ARN) of the source.</p>
     */
    inline void SetSourceArn(const Aws::String& value) { m_sourceArnHasBeenSet = true; m_sourceArn = value; }

    /**
     * <p>The Amazon Resource Name (ARN) of the source.</p>
     */
    inline void SetSourceArn(Aws::String&& value) { m_sourceArnHasBeenSet = true; m_sourceArn = std::move(value); }

    /**
     * <p>The Amazon Resource Name (ARN) of the source.</p>
     */
    inline void SetSourceArn(const char* value) { m_sourceArnHasBeenSet = true; m_sourceArn.assign(value); }

    /**
     * <p>The Amazon Resource Name (ARN) of the source.</p>
     */
    inline TrialComponentMetricSummary& WithSourceArn(const Aws::String& value) { SetSourceArn(value); return *this;}

    /**
     * <p>The Amazon Resource Name (ARN) of the source.</p>
     */
    inline TrialComponentMetricSummary& WithSourceArn(Aws::String&& value) { SetSourceArn(std::move(value)); return *this;}

    /**
     * <p>The Amazon Resource Name (ARN) of the source.</p>
     */
    inline TrialComponentMetricSummary& WithSourceArn(const char* value) { SetSourceArn(value); return *this;}


    /**
     * <p>When the metric was last updated.</p>
     */
    inline const Aws::Utils::DateTime& GetTimeStamp() const{ return m_timeStamp; }

    /**
     * <p>When the metric was last updated.</p>
     */
    inline bool TimeStampHasBeenSet() const { return m_timeStampHasBeenSet; }

    /**
     * <p>When the metric was last updated.</p>
     */
    inline void SetTimeStamp(const Aws::Utils::DateTime& value) { m_timeStampHasBeenSet = true; m_timeStamp = value; }

    /**
     * <p>When the metric was last updated.</p>
     */
    inline void SetTimeStamp(Aws::Utils::DateTime&& value) { m_timeStampHasBeenSet = true; m_timeStamp = std::move(value); }

    /**
     * <p>When the metric was last updated.</p>
     */
    inline TrialComponentMetricSummary& WithTimeStamp(const Aws::Utils::DateTime& value) { SetTimeStamp(value); return *this;}

    /**
     * <p>When the metric was last updated.</p>
     */
    inline TrialComponentMetricSummary& WithTimeStamp(Aws::Utils::DateTime&& value) { SetTimeStamp(std::move(value)); return *this;}


    /**
     * <p>The maximum value of the metric.</p>
     */
    inline double GetMax() const{ return m_max; }

    /**
     * <p>The maximum value of the metric.</p>
     */
    inline bool MaxHasBeenSet() const { return m_maxHasBeenSet; }

    /**
     * <p>The maximum value of the metric.</p>
     */
    inline void SetMax(double value) { m_maxHasBeenSet = true; m_max = value; }

    /**
     * <p>The maximum value of the metric.</p>
     */
    inline TrialComponentMetricSummary& WithMax(double value) { SetMax(value); return *this;}


    /**
     * <p>The minimum value of the metric.</p>
     */
    inline double GetMin() const{ return m_min; }

    /**
     * <p>The minimum value of the metric.</p>
     */
    inline bool MinHasBeenSet() const { return m_minHasBeenSet; }

    /**
     * <p>The minimum value of the metric.</p>
     */
    inline void SetMin(double value) { m_minHasBeenSet = true; m_min = value; }

    /**
     * <p>The minimum value of the metric.</p>
     */
    inline TrialComponentMetricSummary& WithMin(double value) { SetMin(value); return *this;}


    /**
     * <p>The most recent value of the metric.</p>
     */
    inline double GetLast() const{ return m_last; }

    /**
     * <p>The most recent value of the metric.</p>
     */
    inline bool LastHasBeenSet() const { return m_lastHasBeenSet; }

    /**
     * <p>The most recent value of the metric.</p>
     */
    inline void SetLast(double value) { m_lastHasBeenSet = true; m_last = value; }

    /**
     * <p>The most recent value of the metric.</p>
     */
    inline TrialComponentMetricSummary& WithLast(double value) { SetLast(value); return *this;}


    /**
     * <p>The number of samples used to generate the metric.</p>
     */
    inline int GetCount() const{ return m_count; }

    /**
     * <p>The number of samples used to generate the metric.</p>
     */
    inline bool CountHasBeenSet() const { return m_countHasBeenSet; }

    /**
     * <p>The number of samples used to generate the metric.</p>
     */
    inline void SetCount(int value) { m_countHasBeenSet = true; m_count = value; }

    /**
     * <p>The number of samples used to generate the metric.</p>
     */
    inline TrialComponentMetricSummary& WithCount(int value) { SetCount(value); return *this;}


    /**
     * <p>The average value of the metric.</p>
     */
    inline double GetAvg() const{ return m_avg; }

    /**
     * <p>The average value of the metric.</p>
     */
    inline bool AvgHasBeenSet() const { return m_avgHasBeenSet; }

    /**
     * <p>The average value of the metric.</p>
     */
    inline void SetAvg(double value) { m_avgHasBeenSet = true; m_avg = value; }

    /**
     * <p>The average value of the metric.</p>
     */
    inline TrialComponentMetricSummary& WithAvg(double value) { SetAvg(value); return *this;}


    /**
     * <p>The standard deviation of the metric.</p>
     */
    inline double GetStdDev() const{ return m_stdDev; }

    /**
     * <p>The standard deviation of the metric.</p>
     */
    inline bool StdDevHasBeenSet() const { return m_stdDevHasBeenSet; }

    /**
     * <p>The standard deviation of the metric.</p>
     */
    inline void SetStdDev(double value) { m_stdDevHasBeenSet = true; m_stdDev = value; }

    /**
     * <p>The standard deviation of the metric.</p>
     */
    inline TrialComponentMetricSummary& WithStdDev(double value) { SetStdDev(value); return *this;}

  private:

    Aws::String m_metricName;
    bool m_metricNameHasBeenSet;

    Aws::String m_sourceArn;
    bool m_sourceArnHasBeenSet;

    Aws::Utils::DateTime m_timeStamp;
    bool m_timeStampHasBeenSet;

    double m_max;
    bool m_maxHasBeenSet;

    double m_min;
    bool m_minHasBeenSet;

    double m_last;
    bool m_lastHasBeenSet;

    int m_count;
    bool m_countHasBeenSet;

    double m_avg;
    bool m_avgHasBeenSet;

    double m_stdDev;
    bool m_stdDevHasBeenSet;
  };

} // namespace Model
} // namespace SageMaker
} // namespace Aws