/** * 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 namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { /** *

The properties of a trial as returned by the Search * API.

See Also:

AWS API * Reference

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

The name of the trial.

*/ inline const Aws::String& GetTrialName() const{ return m_trialName; } /** *

The name of the trial.

*/ inline bool TrialNameHasBeenSet() const { return m_trialNameHasBeenSet; } /** *

The name of the trial.

*/ inline void SetTrialName(const Aws::String& value) { m_trialNameHasBeenSet = true; m_trialName = value; } /** *

The name of the trial.

*/ inline void SetTrialName(Aws::String&& value) { m_trialNameHasBeenSet = true; m_trialName = std::move(value); } /** *

The name of the trial.

*/ inline void SetTrialName(const char* value) { m_trialNameHasBeenSet = true; m_trialName.assign(value); } /** *

The name of the trial.

*/ inline Trial& WithTrialName(const Aws::String& value) { SetTrialName(value); return *this;} /** *

The name of the trial.

*/ inline Trial& WithTrialName(Aws::String&& value) { SetTrialName(std::move(value)); return *this;} /** *

The name of the trial.

*/ inline Trial& WithTrialName(const char* value) { SetTrialName(value); return *this;} /** *

The Amazon Resource Name (ARN) of the trial.

*/ inline const Aws::String& GetTrialArn() const{ return m_trialArn; } /** *

The Amazon Resource Name (ARN) of the trial.

*/ inline bool TrialArnHasBeenSet() const { return m_trialArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the trial.

*/ inline void SetTrialArn(const Aws::String& value) { m_trialArnHasBeenSet = true; m_trialArn = value; } /** *

The Amazon Resource Name (ARN) of the trial.

*/ inline void SetTrialArn(Aws::String&& value) { m_trialArnHasBeenSet = true; m_trialArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the trial.

*/ inline void SetTrialArn(const char* value) { m_trialArnHasBeenSet = true; m_trialArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the trial.

*/ inline Trial& WithTrialArn(const Aws::String& value) { SetTrialArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the trial.

*/ inline Trial& WithTrialArn(Aws::String&& value) { SetTrialArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the trial.

*/ inline Trial& WithTrialArn(const char* value) { SetTrialArn(value); return *this;} /** *

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

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

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

*/ inline bool DisplayNameHasBeenSet() const { return m_displayNameHasBeenSet; } /** *

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

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

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

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

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

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

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

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

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

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

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

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

The name of the experiment the trial is part of.

*/ inline const Aws::String& GetExperimentName() const{ return m_experimentName; } /** *

The name of the experiment the trial is part of.

*/ inline bool ExperimentNameHasBeenSet() const { return m_experimentNameHasBeenSet; } /** *

The name of the experiment the trial is part of.

*/ inline void SetExperimentName(const Aws::String& value) { m_experimentNameHasBeenSet = true; m_experimentName = value; } /** *

The name of the experiment the trial is part of.

*/ inline void SetExperimentName(Aws::String&& value) { m_experimentNameHasBeenSet = true; m_experimentName = std::move(value); } /** *

The name of the experiment the trial is part of.

*/ inline void SetExperimentName(const char* value) { m_experimentNameHasBeenSet = true; m_experimentName.assign(value); } /** *

The name of the experiment the trial is part of.

*/ inline Trial& WithExperimentName(const Aws::String& value) { SetExperimentName(value); return *this;} /** *

The name of the experiment the trial is part of.

*/ inline Trial& WithExperimentName(Aws::String&& value) { SetExperimentName(std::move(value)); return *this;} /** *

The name of the experiment the trial is part of.

*/ inline Trial& WithExperimentName(const char* value) { SetExperimentName(value); return *this;} inline const TrialSource& GetSource() const{ return m_source; } inline bool SourceHasBeenSet() const { return m_sourceHasBeenSet; } inline void SetSource(const TrialSource& value) { m_sourceHasBeenSet = true; m_source = value; } inline void SetSource(TrialSource&& value) { m_sourceHasBeenSet = true; m_source = std::move(value); } inline Trial& WithSource(const TrialSource& value) { SetSource(value); return *this;} inline Trial& WithSource(TrialSource&& value) { SetSource(std::move(value)); return *this;} /** *

When the trial was created.

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

When the trial was created.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

When the trial was created.

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

When the trial was created.

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

When the trial was created.

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

When the trial was created.

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

Who created the trial.

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

Who created the trial.

*/ inline bool CreatedByHasBeenSet() const { return m_createdByHasBeenSet; } /** *

Who created the trial.

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

Who created the trial.

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

Who created the trial.

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

Who created the trial.

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

Who last modified the trial.

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

Who last modified the trial.

*/ inline bool LastModifiedTimeHasBeenSet() const { return m_lastModifiedTimeHasBeenSet; } /** *

Who last modified the trial.

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

Who last modified the trial.

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

Who last modified the trial.

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

Who last modified the trial.

*/ inline Trial& WithLastModifiedTime(Aws::Utils::DateTime&& value) { SetLastModifiedTime(std::move(value)); return *this;} inline const UserContext& GetLastModifiedBy() const{ return m_lastModifiedBy; } inline bool LastModifiedByHasBeenSet() const { return m_lastModifiedByHasBeenSet; } inline void SetLastModifiedBy(const UserContext& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = value; } inline void SetLastModifiedBy(UserContext&& value) { m_lastModifiedByHasBeenSet = true; m_lastModifiedBy = std::move(value); } inline Trial& WithLastModifiedBy(const UserContext& value) { SetLastModifiedBy(value); return *this;} inline Trial& WithLastModifiedBy(UserContext&& value) { SetLastModifiedBy(std::move(value)); return *this;} inline const MetadataProperties& GetMetadataProperties() const{ return m_metadataProperties; } inline bool MetadataPropertiesHasBeenSet() const { return m_metadataPropertiesHasBeenSet; } inline void SetMetadataProperties(const MetadataProperties& value) { m_metadataPropertiesHasBeenSet = true; m_metadataProperties = value; } inline void SetMetadataProperties(MetadataProperties&& value) { m_metadataPropertiesHasBeenSet = true; m_metadataProperties = std::move(value); } inline Trial& WithMetadataProperties(const MetadataProperties& value) { SetMetadataProperties(value); return *this;} inline Trial& WithMetadataProperties(MetadataProperties&& value) { SetMetadataProperties(std::move(value)); return *this;} /** *

The list of tags that are associated with the trial. You can use Search * API to search on the tags.

*/ inline const Aws::Vector& GetTags() const{ return m_tags; } /** *

The list of tags that are associated with the trial. You can use Search * API to search on the tags.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

The list of tags that are associated with the trial. You can use Search * API to search on the tags.

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

The list of tags that are associated with the trial. You can use Search * API to search on the tags.

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

The list of tags that are associated with the trial. You can use Search * API to search on the tags.

*/ inline Trial& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

The list of tags that are associated with the trial. You can use Search * API to search on the tags.

*/ inline Trial& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

The list of tags that are associated with the trial. You can use Search * API to search on the tags.

*/ inline Trial& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

The list of tags that are associated with the trial. You can use Search * API to search on the tags.

*/ inline Trial& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** *

A list of the components associated with the trial. For each component, a * summary of the component's properties is included.

*/ inline const Aws::Vector& GetTrialComponentSummaries() const{ return m_trialComponentSummaries; } /** *

A list of the components associated with the trial. For each component, a * summary of the component's properties is included.

*/ inline bool TrialComponentSummariesHasBeenSet() const { return m_trialComponentSummariesHasBeenSet; } /** *

A list of the components associated with the trial. For each component, a * summary of the component's properties is included.

*/ inline void SetTrialComponentSummaries(const Aws::Vector& value) { m_trialComponentSummariesHasBeenSet = true; m_trialComponentSummaries = value; } /** *

A list of the components associated with the trial. For each component, a * summary of the component's properties is included.

*/ inline void SetTrialComponentSummaries(Aws::Vector&& value) { m_trialComponentSummariesHasBeenSet = true; m_trialComponentSummaries = std::move(value); } /** *

A list of the components associated with the trial. For each component, a * summary of the component's properties is included.

*/ inline Trial& WithTrialComponentSummaries(const Aws::Vector& value) { SetTrialComponentSummaries(value); return *this;} /** *

A list of the components associated with the trial. For each component, a * summary of the component's properties is included.

*/ inline Trial& WithTrialComponentSummaries(Aws::Vector&& value) { SetTrialComponentSummaries(std::move(value)); return *this;} /** *

A list of the components associated with the trial. For each component, a * summary of the component's properties is included.

*/ inline Trial& AddTrialComponentSummaries(const TrialComponentSimpleSummary& value) { m_trialComponentSummariesHasBeenSet = true; m_trialComponentSummaries.push_back(value); return *this; } /** *

A list of the components associated with the trial. For each component, a * summary of the component's properties is included.

*/ inline Trial& AddTrialComponentSummaries(TrialComponentSimpleSummary&& value) { m_trialComponentSummariesHasBeenSet = true; m_trialComponentSummaries.push_back(std::move(value)); return *this; } private: Aws::String m_trialName; bool m_trialNameHasBeenSet = false; Aws::String m_trialArn; bool m_trialArnHasBeenSet = false; Aws::String m_displayName; bool m_displayNameHasBeenSet = false; Aws::String m_experimentName; bool m_experimentNameHasBeenSet = false; TrialSource m_source; bool m_sourceHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; UserContext m_createdBy; bool m_createdByHasBeenSet = false; Aws::Utils::DateTime m_lastModifiedTime; bool m_lastModifiedTimeHasBeenSet = false; UserContext m_lastModifiedBy; bool m_lastModifiedByHasBeenSet = false; MetadataProperties m_metadataProperties; bool m_metadataPropertiesHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; Aws::Vector m_trialComponentSummaries; bool m_trialComponentSummariesHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws