/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { class DescribeTrialComponentResult { public: AWS_SAGEMAKER_API DescribeTrialComponentResult(); AWS_SAGEMAKER_API DescribeTrialComponentResult(const Aws::AmazonWebServiceResult& result); AWS_SAGEMAKER_API DescribeTrialComponentResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The name of the trial component.

*/ inline const Aws::String& GetTrialComponentName() const{ return m_trialComponentName; } /** *

The name of the trial component.

*/ inline void SetTrialComponentName(const Aws::String& value) { m_trialComponentName = value; } /** *

The name of the trial component.

*/ inline void SetTrialComponentName(Aws::String&& value) { m_trialComponentName = std::move(value); } /** *

The name of the trial component.

*/ inline void SetTrialComponentName(const char* value) { m_trialComponentName.assign(value); } /** *

The name of the trial component.

*/ inline DescribeTrialComponentResult& WithTrialComponentName(const Aws::String& value) { SetTrialComponentName(value); return *this;} /** *

The name of the trial component.

*/ inline DescribeTrialComponentResult& WithTrialComponentName(Aws::String&& value) { SetTrialComponentName(std::move(value)); return *this;} /** *

The name of the trial component.

*/ inline DescribeTrialComponentResult& WithTrialComponentName(const char* value) { SetTrialComponentName(value); return *this;} /** *

The Amazon Resource Name (ARN) of the trial component.

*/ inline const Aws::String& GetTrialComponentArn() const{ return m_trialComponentArn; } /** *

The Amazon Resource Name (ARN) of the trial component.

*/ inline void SetTrialComponentArn(const Aws::String& value) { m_trialComponentArn = value; } /** *

The Amazon Resource Name (ARN) of the trial component.

*/ inline void SetTrialComponentArn(Aws::String&& value) { m_trialComponentArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the trial component.

*/ inline void SetTrialComponentArn(const char* value) { m_trialComponentArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the trial component.

*/ inline DescribeTrialComponentResult& WithTrialComponentArn(const Aws::String& value) { SetTrialComponentArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the trial component.

*/ inline DescribeTrialComponentResult& WithTrialComponentArn(Aws::String&& value) { SetTrialComponentArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the trial component.

*/ inline DescribeTrialComponentResult& WithTrialComponentArn(const char* value) { SetTrialComponentArn(value); return *this;} /** *

The name of the component as displayed. If DisplayName isn't * specified, TrialComponentName is displayed.

*/ inline const Aws::String& GetDisplayName() const{ return m_displayName; } /** *

The name of the component as displayed. If DisplayName isn't * specified, TrialComponentName is displayed.

*/ inline void SetDisplayName(const Aws::String& value) { m_displayName = value; } /** *

The name of the component as displayed. If DisplayName isn't * specified, TrialComponentName is displayed.

*/ inline void SetDisplayName(Aws::String&& value) { m_displayName = std::move(value); } /** *

The name of the component as displayed. If DisplayName isn't * specified, TrialComponentName is displayed.

*/ inline void SetDisplayName(const char* value) { m_displayName.assign(value); } /** *

The name of the component as displayed. If DisplayName isn't * specified, TrialComponentName is displayed.

*/ inline DescribeTrialComponentResult& WithDisplayName(const Aws::String& value) { SetDisplayName(value); return *this;} /** *

The name of the component as displayed. If DisplayName isn't * specified, TrialComponentName is displayed.

*/ inline DescribeTrialComponentResult& WithDisplayName(Aws::String&& value) { SetDisplayName(std::move(value)); return *this;} /** *

The name of the component as displayed. If DisplayName isn't * specified, TrialComponentName is displayed.

*/ inline DescribeTrialComponentResult& WithDisplayName(const char* value) { SetDisplayName(value); return *this;} /** *

The Amazon Resource Name (ARN) of the source and, optionally, the job * type.

*/ inline const TrialComponentSource& GetSource() const{ return m_source; } /** *

The Amazon Resource Name (ARN) of the source and, optionally, the job * type.

*/ inline void SetSource(const TrialComponentSource& value) { m_source = value; } /** *

The Amazon Resource Name (ARN) of the source and, optionally, the job * type.

*/ inline void SetSource(TrialComponentSource&& value) { m_source = std::move(value); } /** *

The Amazon Resource Name (ARN) of the source and, optionally, the job * type.

*/ inline DescribeTrialComponentResult& WithSource(const TrialComponentSource& value) { SetSource(value); return *this;} /** *

The Amazon Resource Name (ARN) of the source and, optionally, the job * type.

*/ inline DescribeTrialComponentResult& WithSource(TrialComponentSource&& value) { SetSource(std::move(value)); return *this;} /** *

The status of the component. States include:

  • InProgress

    *
  • Completed

  • Failed

*/ inline const TrialComponentStatus& GetStatus() const{ return m_status; } /** *

The status of the component. States include:

  • InProgress

    *
  • Completed

  • Failed

*/ inline void SetStatus(const TrialComponentStatus& value) { m_status = value; } /** *

The status of the component. States include:

  • InProgress

    *
  • Completed

  • Failed

*/ inline void SetStatus(TrialComponentStatus&& value) { m_status = std::move(value); } /** *

The status of the component. States include:

  • InProgress

    *
  • Completed

  • Failed

*/ inline DescribeTrialComponentResult& WithStatus(const TrialComponentStatus& value) { SetStatus(value); return *this;} /** *

The status of the component. States include:

  • InProgress

    *
  • Completed

  • Failed

*/ inline DescribeTrialComponentResult& WithStatus(TrialComponentStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

When the component started.

*/ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** *

When the component started.

*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTime = value; } /** *

When the component started.

*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTime = std::move(value); } /** *

When the component started.

*/ inline DescribeTrialComponentResult& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *

When the component started.

*/ inline DescribeTrialComponentResult& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} /** *

When the component ended.

*/ inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; } /** *

When the component ended.

*/ inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTime = value; } /** *

When the component ended.

*/ inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTime = std::move(value); } /** *

When the component ended.

*/ inline DescribeTrialComponentResult& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;} /** *

When the component ended.

*/ inline DescribeTrialComponentResult& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} /** *

When the component was created.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

When the component was created.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTime = value; } /** *

When the component was created.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTime = std::move(value); } /** *

When the component was created.

*/ inline DescribeTrialComponentResult& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

When the component was created.

*/ inline DescribeTrialComponentResult& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

Who created the trial component.

*/ inline const UserContext& GetCreatedBy() const{ return m_createdBy; } /** *

Who created the trial component.

*/ inline void SetCreatedBy(const UserContext& value) { m_createdBy = value; } /** *

Who created the trial component.

*/ inline void SetCreatedBy(UserContext&& value) { m_createdBy = std::move(value); } /** *

Who created the trial component.

*/ inline DescribeTrialComponentResult& WithCreatedBy(const UserContext& value) { SetCreatedBy(value); return *this;} /** *

Who created the trial component.

*/ inline DescribeTrialComponentResult& WithCreatedBy(UserContext&& value) { SetCreatedBy(std::move(value)); return *this;} /** *

When the component was last modified.

*/ inline const Aws::Utils::DateTime& GetLastModifiedTime() const{ return m_lastModifiedTime; } /** *

When the component was last modified.

*/ inline void SetLastModifiedTime(const Aws::Utils::DateTime& value) { m_lastModifiedTime = value; } /** *

When the component was last modified.

*/ inline void SetLastModifiedTime(Aws::Utils::DateTime&& value) { m_lastModifiedTime = std::move(value); } /** *

When the component was last modified.

*/ inline DescribeTrialComponentResult& WithLastModifiedTime(const Aws::Utils::DateTime& value) { SetLastModifiedTime(value); return *this;} /** *

When the component was last modified.

*/ inline DescribeTrialComponentResult& WithLastModifiedTime(Aws::Utils::DateTime&& value) { SetLastModifiedTime(std::move(value)); return *this;} /** *

Who last modified the component.

*/ inline const UserContext& GetLastModifiedBy() const{ return m_lastModifiedBy; } /** *

Who last modified the component.

*/ inline void SetLastModifiedBy(const UserContext& value) { m_lastModifiedBy = value; } /** *

Who last modified the component.

*/ inline void SetLastModifiedBy(UserContext&& value) { m_lastModifiedBy = std::move(value); } /** *

Who last modified the component.

*/ inline DescribeTrialComponentResult& WithLastModifiedBy(const UserContext& value) { SetLastModifiedBy(value); return *this;} /** *

Who last modified the component.

*/ inline DescribeTrialComponentResult& WithLastModifiedBy(UserContext&& value) { SetLastModifiedBy(std::move(value)); return *this;} /** *

The hyperparameters of the component.

*/ inline const Aws::Map& GetParameters() const{ return m_parameters; } /** *

The hyperparameters of the component.

*/ inline void SetParameters(const Aws::Map& value) { m_parameters = value; } /** *

The hyperparameters of the component.

*/ inline void SetParameters(Aws::Map&& value) { m_parameters = std::move(value); } /** *

The hyperparameters of the component.

*/ inline DescribeTrialComponentResult& WithParameters(const Aws::Map& value) { SetParameters(value); return *this;} /** *

The hyperparameters of the component.

*/ inline DescribeTrialComponentResult& WithParameters(Aws::Map&& value) { SetParameters(std::move(value)); return *this;} /** *

The hyperparameters of the component.

*/ inline DescribeTrialComponentResult& AddParameters(const Aws::String& key, const TrialComponentParameterValue& value) { m_parameters.emplace(key, value); return *this; } /** *

The hyperparameters of the component.

*/ inline DescribeTrialComponentResult& AddParameters(Aws::String&& key, const TrialComponentParameterValue& value) { m_parameters.emplace(std::move(key), value); return *this; } /** *

The hyperparameters of the component.

*/ inline DescribeTrialComponentResult& AddParameters(const Aws::String& key, TrialComponentParameterValue&& value) { m_parameters.emplace(key, std::move(value)); return *this; } /** *

The hyperparameters of the component.

*/ inline DescribeTrialComponentResult& AddParameters(Aws::String&& key, TrialComponentParameterValue&& value) { m_parameters.emplace(std::move(key), std::move(value)); return *this; } /** *

The hyperparameters of the component.

*/ inline DescribeTrialComponentResult& AddParameters(const char* key, TrialComponentParameterValue&& value) { m_parameters.emplace(key, std::move(value)); return *this; } /** *

The hyperparameters of the component.

*/ inline DescribeTrialComponentResult& AddParameters(const char* key, const TrialComponentParameterValue& value) { m_parameters.emplace(key, value); return *this; } /** *

The input artifacts of the component.

*/ inline const Aws::Map& GetInputArtifacts() const{ return m_inputArtifacts; } /** *

The input artifacts of the component.

*/ inline void SetInputArtifacts(const Aws::Map& value) { m_inputArtifacts = value; } /** *

The input artifacts of the component.

*/ inline void SetInputArtifacts(Aws::Map&& value) { m_inputArtifacts = std::move(value); } /** *

The input artifacts of the component.

*/ inline DescribeTrialComponentResult& WithInputArtifacts(const Aws::Map& value) { SetInputArtifacts(value); return *this;} /** *

The input artifacts of the component.

*/ inline DescribeTrialComponentResult& WithInputArtifacts(Aws::Map&& value) { SetInputArtifacts(std::move(value)); return *this;} /** *

The input artifacts of the component.

*/ inline DescribeTrialComponentResult& AddInputArtifacts(const Aws::String& key, const TrialComponentArtifact& value) { m_inputArtifacts.emplace(key, value); return *this; } /** *

The input artifacts of the component.

*/ inline DescribeTrialComponentResult& AddInputArtifacts(Aws::String&& key, const TrialComponentArtifact& value) { m_inputArtifacts.emplace(std::move(key), value); return *this; } /** *

The input artifacts of the component.

*/ inline DescribeTrialComponentResult& AddInputArtifacts(const Aws::String& key, TrialComponentArtifact&& value) { m_inputArtifacts.emplace(key, std::move(value)); return *this; } /** *

The input artifacts of the component.

*/ inline DescribeTrialComponentResult& AddInputArtifacts(Aws::String&& key, TrialComponentArtifact&& value) { m_inputArtifacts.emplace(std::move(key), std::move(value)); return *this; } /** *

The input artifacts of the component.

*/ inline DescribeTrialComponentResult& AddInputArtifacts(const char* key, TrialComponentArtifact&& value) { m_inputArtifacts.emplace(key, std::move(value)); return *this; } /** *

The input artifacts of the component.

*/ inline DescribeTrialComponentResult& AddInputArtifacts(const char* key, const TrialComponentArtifact& value) { m_inputArtifacts.emplace(key, value); return *this; } /** *

The output artifacts of the component.

*/ inline const Aws::Map& GetOutputArtifacts() const{ return m_outputArtifacts; } /** *

The output artifacts of the component.

*/ inline void SetOutputArtifacts(const Aws::Map& value) { m_outputArtifacts = value; } /** *

The output artifacts of the component.

*/ inline void SetOutputArtifacts(Aws::Map&& value) { m_outputArtifacts = std::move(value); } /** *

The output artifacts of the component.

*/ inline DescribeTrialComponentResult& WithOutputArtifacts(const Aws::Map& value) { SetOutputArtifacts(value); return *this;} /** *

The output artifacts of the component.

*/ inline DescribeTrialComponentResult& WithOutputArtifacts(Aws::Map&& value) { SetOutputArtifacts(std::move(value)); return *this;} /** *

The output artifacts of the component.

*/ inline DescribeTrialComponentResult& AddOutputArtifacts(const Aws::String& key, const TrialComponentArtifact& value) { m_outputArtifacts.emplace(key, value); return *this; } /** *

The output artifacts of the component.

*/ inline DescribeTrialComponentResult& AddOutputArtifacts(Aws::String&& key, const TrialComponentArtifact& value) { m_outputArtifacts.emplace(std::move(key), value); return *this; } /** *

The output artifacts of the component.

*/ inline DescribeTrialComponentResult& AddOutputArtifacts(const Aws::String& key, TrialComponentArtifact&& value) { m_outputArtifacts.emplace(key, std::move(value)); return *this; } /** *

The output artifacts of the component.

*/ inline DescribeTrialComponentResult& AddOutputArtifacts(Aws::String&& key, TrialComponentArtifact&& value) { m_outputArtifacts.emplace(std::move(key), std::move(value)); return *this; } /** *

The output artifacts of the component.

*/ inline DescribeTrialComponentResult& AddOutputArtifacts(const char* key, TrialComponentArtifact&& value) { m_outputArtifacts.emplace(key, std::move(value)); return *this; } /** *

The output artifacts of the component.

*/ inline DescribeTrialComponentResult& AddOutputArtifacts(const char* key, const TrialComponentArtifact& value) { m_outputArtifacts.emplace(key, value); return *this; } inline const MetadataProperties& GetMetadataProperties() const{ return m_metadataProperties; } inline void SetMetadataProperties(const MetadataProperties& value) { m_metadataProperties = value; } inline void SetMetadataProperties(MetadataProperties&& value) { m_metadataProperties = std::move(value); } inline DescribeTrialComponentResult& WithMetadataProperties(const MetadataProperties& value) { SetMetadataProperties(value); return *this;} inline DescribeTrialComponentResult& WithMetadataProperties(MetadataProperties&& value) { SetMetadataProperties(std::move(value)); return *this;} /** *

The metrics for the component.

*/ inline const Aws::Vector& GetMetrics() const{ return m_metrics; } /** *

The metrics for the component.

*/ inline void SetMetrics(const Aws::Vector& value) { m_metrics = value; } /** *

The metrics for the component.

*/ inline void SetMetrics(Aws::Vector&& value) { m_metrics = std::move(value); } /** *

The metrics for the component.

*/ inline DescribeTrialComponentResult& WithMetrics(const Aws::Vector& value) { SetMetrics(value); return *this;} /** *

The metrics for the component.

*/ inline DescribeTrialComponentResult& WithMetrics(Aws::Vector&& value) { SetMetrics(std::move(value)); return *this;} /** *

The metrics for the component.

*/ inline DescribeTrialComponentResult& AddMetrics(const TrialComponentMetricSummary& value) { m_metrics.push_back(value); return *this; } /** *

The metrics for the component.

*/ inline DescribeTrialComponentResult& AddMetrics(TrialComponentMetricSummary&& value) { m_metrics.push_back(std::move(value)); return *this; } /** *

The Amazon Resource Name (ARN) of the lineage group.

*/ inline const Aws::String& GetLineageGroupArn() const{ return m_lineageGroupArn; } /** *

The Amazon Resource Name (ARN) of the lineage group.

*/ inline void SetLineageGroupArn(const Aws::String& value) { m_lineageGroupArn = value; } /** *

The Amazon Resource Name (ARN) of the lineage group.

*/ inline void SetLineageGroupArn(Aws::String&& value) { m_lineageGroupArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the lineage group.

*/ inline void SetLineageGroupArn(const char* value) { m_lineageGroupArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the lineage group.

*/ inline DescribeTrialComponentResult& WithLineageGroupArn(const Aws::String& value) { SetLineageGroupArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the lineage group.

*/ inline DescribeTrialComponentResult& WithLineageGroupArn(Aws::String&& value) { SetLineageGroupArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the lineage group.

*/ inline DescribeTrialComponentResult& WithLineageGroupArn(const char* value) { SetLineageGroupArn(value); return *this;} /** *

A list of ARNs and, if applicable, job types for multiple sources of an * experiment run.

*/ inline const Aws::Vector& GetSources() const{ return m_sources; } /** *

A list of ARNs and, if applicable, job types for multiple sources of an * experiment run.

*/ inline void SetSources(const Aws::Vector& value) { m_sources = value; } /** *

A list of ARNs and, if applicable, job types for multiple sources of an * experiment run.

*/ inline void SetSources(Aws::Vector&& value) { m_sources = std::move(value); } /** *

A list of ARNs and, if applicable, job types for multiple sources of an * experiment run.

*/ inline DescribeTrialComponentResult& WithSources(const Aws::Vector& value) { SetSources(value); return *this;} /** *

A list of ARNs and, if applicable, job types for multiple sources of an * experiment run.

*/ inline DescribeTrialComponentResult& WithSources(Aws::Vector&& value) { SetSources(std::move(value)); return *this;} /** *

A list of ARNs and, if applicable, job types for multiple sources of an * experiment run.

*/ inline DescribeTrialComponentResult& AddSources(const TrialComponentSource& value) { m_sources.push_back(value); return *this; } /** *

A list of ARNs and, if applicable, job types for multiple sources of an * experiment run.

*/ inline DescribeTrialComponentResult& AddSources(TrialComponentSource&& value) { m_sources.push_back(std::move(value)); return *this; } inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeTrialComponentResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeTrialComponentResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeTrialComponentResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_trialComponentName; Aws::String m_trialComponentArn; Aws::String m_displayName; TrialComponentSource m_source; TrialComponentStatus m_status; Aws::Utils::DateTime m_startTime; Aws::Utils::DateTime m_endTime; Aws::Utils::DateTime m_creationTime; UserContext m_createdBy; Aws::Utils::DateTime m_lastModifiedTime; UserContext m_lastModifiedBy; Aws::Map m_parameters; Aws::Map m_inputArtifacts; Aws::Map m_outputArtifacts; MetadataProperties m_metadataProperties; Aws::Vector m_metrics; Aws::String m_lineageGroupArn; Aws::Vector m_sources; Aws::String m_requestId; }; } // namespace Model } // namespace SageMaker } // namespace Aws