MLModel.h

Go to the documentation of this file.

/*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
*  http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
#pragma once
#include <aws/machinelearning/MachineLearning_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/DateTime.h>
#include <aws/machinelearning/model/EntityStatus.h>
#include <aws/machinelearning/model/RealtimeEndpointInfo.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <aws/machinelearning/model/Algorithm.h>
#include <aws/machinelearning/model/MLModelType.h>

namespace Aws
{
namespace Utils
{
namespace Json
{
  class JsonValue;
} // namespace Json
} // namespace Utils
namespace MachineLearning
{
namespace Model
{

  class AWS_MACHINELEARNING_API MLModel
  {
  public:
    MLModel();
    MLModel(const Aws::Utils::Json::JsonValue& jsonValue);
    MLModel& operator=(const Aws::Utils::Json::JsonValue& jsonValue);
    Aws::Utils::Json::JsonValue Jsonize() const;

    inline const Aws::String& GetMLModelId() const{ return m_mLModelId; }

    inline void SetMLModelId(const Aws::String& value) { m_mLModelIdHasBeenSet = true; m_mLModelId = value; }

    inline void SetMLModelId(Aws::String&& value) { m_mLModelIdHasBeenSet = true; m_mLModelId = value; }

    inline void SetMLModelId(const char* value) { m_mLModelIdHasBeenSet = true; m_mLModelId.assign(value); }

    inline MLModel& WithMLModelId(const Aws::String& value) { SetMLModelId(value); return *this;}

    inline MLModel& WithMLModelId(Aws::String&& value) { SetMLModelId(value); return *this;}

    inline MLModel& WithMLModelId(const char* value) { SetMLModelId(value); return *this;}

    inline const Aws::String& GetTrainingDataSourceId() const{ return m_trainingDataSourceId; }

    inline void SetTrainingDataSourceId(const Aws::String& value) { m_trainingDataSourceIdHasBeenSet = true; m_trainingDataSourceId = value; }

    inline void SetTrainingDataSourceId(Aws::String&& value) { m_trainingDataSourceIdHasBeenSet = true; m_trainingDataSourceId = value; }

    inline void SetTrainingDataSourceId(const char* value) { m_trainingDataSourceIdHasBeenSet = true; m_trainingDataSourceId.assign(value); }

    inline MLModel& WithTrainingDataSourceId(const Aws::String& value) { SetTrainingDataSourceId(value); return *this;}

    inline MLModel& WithTrainingDataSourceId(Aws::String&& value) { SetTrainingDataSourceId(value); return *this;}

    inline MLModel& WithTrainingDataSourceId(const char* value) { SetTrainingDataSourceId(value); return *this;}

    inline const Aws::String& GetCreatedByIamUser() const{ return m_createdByIamUser; }

    inline void SetCreatedByIamUser(const Aws::String& value) { m_createdByIamUserHasBeenSet = true; m_createdByIamUser = value; }

    inline void SetCreatedByIamUser(Aws::String&& value) { m_createdByIamUserHasBeenSet = true; m_createdByIamUser = value; }

    inline void SetCreatedByIamUser(const char* value) { m_createdByIamUserHasBeenSet = true; m_createdByIamUser.assign(value); }

    inline MLModel& WithCreatedByIamUser(const Aws::String& value) { SetCreatedByIamUser(value); return *this;}

    inline MLModel& WithCreatedByIamUser(Aws::String&& value) { SetCreatedByIamUser(value); return *this;}

    inline MLModel& WithCreatedByIamUser(const char* value) { SetCreatedByIamUser(value); return *this;}

    inline const Aws::Utils::DateTime& GetCreatedAt() const{ return m_createdAt; }

    inline void SetCreatedAt(const Aws::Utils::DateTime& value) { m_createdAtHasBeenSet = true; m_createdAt = value; }

    inline void SetCreatedAt(Aws::Utils::DateTime&& value) { m_createdAtHasBeenSet = true; m_createdAt = value; }

    inline MLModel& WithCreatedAt(const Aws::Utils::DateTime& value) { SetCreatedAt(value); return *this;}

    inline MLModel& WithCreatedAt(Aws::Utils::DateTime&& value) { SetCreatedAt(value); return *this;}

    inline const Aws::Utils::DateTime& GetLastUpdatedAt() const{ return m_lastUpdatedAt; }

    inline void SetLastUpdatedAt(const Aws::Utils::DateTime& value) { m_lastUpdatedAtHasBeenSet = true; m_lastUpdatedAt = value; }

    inline void SetLastUpdatedAt(Aws::Utils::DateTime&& value) { m_lastUpdatedAtHasBeenSet = true; m_lastUpdatedAt = value; }

    inline MLModel& WithLastUpdatedAt(const Aws::Utils::DateTime& value) { SetLastUpdatedAt(value); return *this;}

    inline MLModel& WithLastUpdatedAt(Aws::Utils::DateTime&& value) { SetLastUpdatedAt(value); return *this;}

    inline const Aws::String& GetName() const{ return m_name; }

    inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }

    inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = value; }

    inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }

    inline MLModel& WithName(const Aws::String& value) { SetName(value); return *this;}

    inline MLModel& WithName(Aws::String&& value) { SetName(value); return *this;}

    inline MLModel& WithName(const char* value) { SetName(value); return *this;}

    inline const EntityStatus& GetStatus() const{ return m_status; }

    inline void SetStatus(const EntityStatus& value) { m_statusHasBeenSet = true; m_status = value; }

    inline void SetStatus(EntityStatus&& value) { m_statusHasBeenSet = true; m_status = value; }

    inline MLModel& WithStatus(const EntityStatus& value) { SetStatus(value); return *this;}

    inline MLModel& WithStatus(EntityStatus&& value) { SetStatus(value); return *this;}

    
    inline long long GetSizeInBytes() const{ return m_sizeInBytes; }

    
    inline void SetSizeInBytes(long long value) { m_sizeInBytesHasBeenSet = true; m_sizeInBytes = value; }

    
    inline MLModel& WithSizeInBytes(long long value) { SetSizeInBytes(value); return *this;}

    inline const RealtimeEndpointInfo& GetEndpointInfo() const{ return m_endpointInfo; }

    inline void SetEndpointInfo(const RealtimeEndpointInfo& value) { m_endpointInfoHasBeenSet = true; m_endpointInfo = value; }

    inline void SetEndpointInfo(RealtimeEndpointInfo&& value) { m_endpointInfoHasBeenSet = true; m_endpointInfo = value; }

    inline MLModel& WithEndpointInfo(const RealtimeEndpointInfo& value) { SetEndpointInfo(value); return *this;}

    inline MLModel& WithEndpointInfo(RealtimeEndpointInfo&& value) { SetEndpointInfo(value); return *this;}

    inline const Aws::Map<Aws::String, Aws::String>& GetTrainingParameters() const{ return m_trainingParameters; }

    inline void SetTrainingParameters(const Aws::Map<Aws::String, Aws::String>& value) { m_trainingParametersHasBeenSet = true; m_trainingParameters = value; }

    inline void SetTrainingParameters(Aws::Map<Aws::String, Aws::String>&& value) { m_trainingParametersHasBeenSet = true; m_trainingParameters = value; }

    inline MLModel& WithTrainingParameters(const Aws::Map<Aws::String, Aws::String>& value) { SetTrainingParameters(value); return *this;}

    inline MLModel& WithTrainingParameters(Aws::Map<Aws::String, Aws::String>&& value) { SetTrainingParameters(value); return *this;}

    inline MLModel& AddTrainingParameters(const Aws::String& key, const Aws::String& value) { m_trainingParametersHasBeenSet = true; m_trainingParameters[key] = value; return *this; }

    inline MLModel& AddTrainingParameters(Aws::String&& key, const Aws::String& value) { m_trainingParametersHasBeenSet = true; m_trainingParameters[key] = value; return *this; }

    inline MLModel& AddTrainingParameters(const Aws::String& key, Aws::String&& value) { m_trainingParametersHasBeenSet = true; m_trainingParameters[key] = value; return *this; }

    inline MLModel& AddTrainingParameters(Aws::String&& key, Aws::String&& value) { m_trainingParametersHasBeenSet = true; m_trainingParameters[key] = value; return *this; }

    inline MLModel& AddTrainingParameters(const char* key, Aws::String&& value) { m_trainingParametersHasBeenSet = true; m_trainingParameters[key] = value; return *this; }

    inline MLModel& AddTrainingParameters(Aws::String&& key, const char* value) { m_trainingParametersHasBeenSet = true; m_trainingParameters[key] = value; return *this; }

    inline MLModel& AddTrainingParameters(const char* key, const char* value) { m_trainingParametersHasBeenSet = true; m_trainingParameters[key] = value; return *this; }

    inline const Aws::String& GetInputDataLocationS3() const{ return m_inputDataLocationS3; }

    inline void SetInputDataLocationS3(const Aws::String& value) { m_inputDataLocationS3HasBeenSet = true; m_inputDataLocationS3 = value; }

    inline void SetInputDataLocationS3(Aws::String&& value) { m_inputDataLocationS3HasBeenSet = true; m_inputDataLocationS3 = value; }

    inline void SetInputDataLocationS3(const char* value) { m_inputDataLocationS3HasBeenSet = true; m_inputDataLocationS3.assign(value); }

    inline MLModel& WithInputDataLocationS3(const Aws::String& value) { SetInputDataLocationS3(value); return *this;}

    inline MLModel& WithInputDataLocationS3(Aws::String&& value) { SetInputDataLocationS3(value); return *this;}

    inline MLModel& WithInputDataLocationS3(const char* value) { SetInputDataLocationS3(value); return *this;}

    inline const Algorithm& GetAlgorithm() const{ return m_algorithm; }

    inline void SetAlgorithm(const Algorithm& value) { m_algorithmHasBeenSet = true; m_algorithm = value; }

    inline void SetAlgorithm(Algorithm&& value) { m_algorithmHasBeenSet = true; m_algorithm = value; }

    inline MLModel& WithAlgorithm(const Algorithm& value) { SetAlgorithm(value); return *this;}

    inline MLModel& WithAlgorithm(Algorithm&& value) { SetAlgorithm(value); return *this;}

    inline const MLModelType& GetMLModelType() const{ return m_mLModelType; }

    inline void SetMLModelType(const MLModelType& value) { m_mLModelTypeHasBeenSet = true; m_mLModelType = value; }

    inline void SetMLModelType(MLModelType&& value) { m_mLModelTypeHasBeenSet = true; m_mLModelType = value; }

    inline MLModel& WithMLModelType(const MLModelType& value) { SetMLModelType(value); return *this;}

    inline MLModel& WithMLModelType(MLModelType&& value) { SetMLModelType(value); return *this;}

    
    inline double GetScoreThreshold() const{ return m_scoreThreshold; }

    
    inline void SetScoreThreshold(double value) { m_scoreThresholdHasBeenSet = true; m_scoreThreshold = value; }

    
    inline MLModel& WithScoreThreshold(double value) { SetScoreThreshold(value); return *this;}

    inline const Aws::Utils::DateTime& GetScoreThresholdLastUpdatedAt() const{ return m_scoreThresholdLastUpdatedAt; }

    inline void SetScoreThresholdLastUpdatedAt(const Aws::Utils::DateTime& value) { m_scoreThresholdLastUpdatedAtHasBeenSet = true; m_scoreThresholdLastUpdatedAt = value; }

    inline void SetScoreThresholdLastUpdatedAt(Aws::Utils::DateTime&& value) { m_scoreThresholdLastUpdatedAtHasBeenSet = true; m_scoreThresholdLastUpdatedAt = value; }

    inline MLModel& WithScoreThresholdLastUpdatedAt(const Aws::Utils::DateTime& value) { SetScoreThresholdLastUpdatedAt(value); return *this;}

    inline MLModel& WithScoreThresholdLastUpdatedAt(Aws::Utils::DateTime&& value) { SetScoreThresholdLastUpdatedAt(value); return *this;}

    inline const Aws::String& GetMessage() const{ return m_message; }

    inline void SetMessage(const Aws::String& value) { m_messageHasBeenSet = true; m_message = value; }

    inline void SetMessage(Aws::String&& value) { m_messageHasBeenSet = true; m_message = value; }

    inline void SetMessage(const char* value) { m_messageHasBeenSet = true; m_message.assign(value); }

    inline MLModel& WithMessage(const Aws::String& value) { SetMessage(value); return *this;}

    inline MLModel& WithMessage(Aws::String&& value) { SetMessage(value); return *this;}

    inline MLModel& WithMessage(const char* value) { SetMessage(value); return *this;}

  private:
    Aws::String m_mLModelId;
    bool m_mLModelIdHasBeenSet;
    Aws::String m_trainingDataSourceId;
    bool m_trainingDataSourceIdHasBeenSet;
    Aws::String m_createdByIamUser;
    bool m_createdByIamUserHasBeenSet;
    Aws::Utils::DateTime m_createdAt;
    bool m_createdAtHasBeenSet;
    Aws::Utils::DateTime m_lastUpdatedAt;
    bool m_lastUpdatedAtHasBeenSet;
    Aws::String m_name;
    bool m_nameHasBeenSet;
    EntityStatus m_status;
    bool m_statusHasBeenSet;
    long long m_sizeInBytes;
    bool m_sizeInBytesHasBeenSet;
    RealtimeEndpointInfo m_endpointInfo;
    bool m_endpointInfoHasBeenSet;
    Aws::Map<Aws::String, Aws::String> m_trainingParameters;
    bool m_trainingParametersHasBeenSet;
    Aws::String m_inputDataLocationS3;
    bool m_inputDataLocationS3HasBeenSet;
    Algorithm m_algorithm;
    bool m_algorithmHasBeenSet;
    MLModelType m_mLModelType;
    bool m_mLModelTypeHasBeenSet;
    double m_scoreThreshold;
    bool m_scoreThresholdHasBeenSet;
    Aws::Utils::DateTime m_scoreThresholdLastUpdatedAt;
    bool m_scoreThresholdLastUpdatedAtHasBeenSet;
    Aws::String m_message;
    bool m_messageHasBeenSet;
  };

} // namespace Model
} // namespace MachineLearning
} // namespace Aws