pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-sagemaker/include/aws/sagemaker/model/StoppingCondition.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>

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

  /**
   * <p>Specifies a limit to how long a model training or compilation job can run. It
   * also specifies how long you are willing to wait for a managed spot training job
   * to complete. When the job reaches the time limit, Amazon SageMaker ends the
   * training or compilation job. Use this API to cap model training costs.</p> <p>To
   * stop a job, Amazon SageMaker sends the algorithm the <code>SIGTERM</code>
   * signal, which delays job termination for 120 seconds. Algorithms can use this
   * 120-second window to save the model artifacts, so the results of training are
   * not lost. </p> <p>The training algorithms provided by Amazon SageMaker
   * automatically save the intermediate results of a model training job when
   * possible. This attempt to save artifacts is only a best effort case as model
   * might not be in a state from which it can be saved. For example, if training has
   * just started, the model might not be ready to save. When saved, this
   * intermediate data is a valid model artifact. You can use it to create a model
   * with <code>CreateModel</code>.</p>  <p>The Neural Topic Model (NTM)
   * currently does not support saving intermediate model artifacts. When training
   * NTMs, make sure that the maximum runtime is sufficient for the training job to
   * complete.</p> <p><h3>See Also:</h3>   <a
   * href="http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StoppingCondition">AWS
   * API Reference</a></p>
   */
  class AWS_SAGEMAKER_API StoppingCondition
  {
  public:
    StoppingCondition();
    StoppingCondition(Aws::Utils::Json::JsonView jsonValue);
    StoppingCondition& operator=(Aws::Utils::Json::JsonView jsonValue);
    Aws::Utils::Json::JsonValue Jsonize() const;


    /**
     * <p>The maximum length of time, in seconds, that the training or compilation job
     * can run. If job does not complete during this time, Amazon SageMaker ends the
     * job. If value is not specified, default value is 1 day. The maximum value is 28
     * days.</p>
     */
    inline int GetMaxRuntimeInSeconds() const{ return m_maxRuntimeInSeconds; }

    /**
     * <p>The maximum length of time, in seconds, that the training or compilation job
     * can run. If job does not complete during this time, Amazon SageMaker ends the
     * job. If value is not specified, default value is 1 day. The maximum value is 28
     * days.</p>
     */
    inline bool MaxRuntimeInSecondsHasBeenSet() const { return m_maxRuntimeInSecondsHasBeenSet; }

    /**
     * <p>The maximum length of time, in seconds, that the training or compilation job
     * can run. If job does not complete during this time, Amazon SageMaker ends the
     * job. If value is not specified, default value is 1 day. The maximum value is 28
     * days.</p>
     */
    inline void SetMaxRuntimeInSeconds(int value) { m_maxRuntimeInSecondsHasBeenSet = true; m_maxRuntimeInSeconds = value; }

    /**
     * <p>The maximum length of time, in seconds, that the training or compilation job
     * can run. If job does not complete during this time, Amazon SageMaker ends the
     * job. If value is not specified, default value is 1 day. The maximum value is 28
     * days.</p>
     */
    inline StoppingCondition& WithMaxRuntimeInSeconds(int value) { SetMaxRuntimeInSeconds(value); return *this;}


    /**
     * <p>The maximum length of time, in seconds, how long you are willing to wait for
     * a managed spot training job to complete. It is the amount of time spent waiting
     * for Spot capacity plus the amount of time the training job runs. It must be
     * equal to or greater than <code>MaxRuntimeInSeconds</code>. </p>
     */
    inline int GetMaxWaitTimeInSeconds() const{ return m_maxWaitTimeInSeconds; }

    /**
     * <p>The maximum length of time, in seconds, how long you are willing to wait for
     * a managed spot training job to complete. It is the amount of time spent waiting
     * for Spot capacity plus the amount of time the training job runs. It must be
     * equal to or greater than <code>MaxRuntimeInSeconds</code>. </p>
     */
    inline bool MaxWaitTimeInSecondsHasBeenSet() const { return m_maxWaitTimeInSecondsHasBeenSet; }

    /**
     * <p>The maximum length of time, in seconds, how long you are willing to wait for
     * a managed spot training job to complete. It is the amount of time spent waiting
     * for Spot capacity plus the amount of time the training job runs. It must be
     * equal to or greater than <code>MaxRuntimeInSeconds</code>. </p>
     */
    inline void SetMaxWaitTimeInSeconds(int value) { m_maxWaitTimeInSecondsHasBeenSet = true; m_maxWaitTimeInSeconds = value; }

    /**
     * <p>The maximum length of time, in seconds, how long you are willing to wait for
     * a managed spot training job to complete. It is the amount of time spent waiting
     * for Spot capacity plus the amount of time the training job runs. It must be
     * equal to or greater than <code>MaxRuntimeInSeconds</code>. </p>
     */
    inline StoppingCondition& WithMaxWaitTimeInSeconds(int value) { SetMaxWaitTimeInSeconds(value); return *this;}

  private:

    int m_maxRuntimeInSeconds;
    bool m_maxRuntimeInSecondsHasBeenSet;

    int m_maxWaitTimeInSeconds;
    bool m_maxWaitTimeInSecondsHasBeenSet;
  };

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