/** * 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 namespace Aws { namespace SageMaker { namespace Model { /** */ class ListTrialComponentsRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API ListTrialComponentsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ListTrialComponents"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

A filter that returns only components that are part of the specified * experiment. If you specify ExperimentName, you can't filter by * SourceArn or TrialName.

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

A filter that returns only components that are part of the specified * experiment. If you specify ExperimentName, you can't filter by * SourceArn or TrialName.

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

A filter that returns only components that are part of the specified * experiment. If you specify ExperimentName, you can't filter by * SourceArn or TrialName.

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

A filter that returns only components that are part of the specified * experiment. If you specify ExperimentName, you can't filter by * SourceArn or TrialName.

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

A filter that returns only components that are part of the specified * experiment. If you specify ExperimentName, you can't filter by * SourceArn or TrialName.

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

A filter that returns only components that are part of the specified * experiment. If you specify ExperimentName, you can't filter by * SourceArn or TrialName.

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

A filter that returns only components that are part of the specified * experiment. If you specify ExperimentName, you can't filter by * SourceArn or TrialName.

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

A filter that returns only components that are part of the specified * experiment. If you specify ExperimentName, you can't filter by * SourceArn or TrialName.

*/ inline ListTrialComponentsRequest& WithExperimentName(const char* value) { SetExperimentName(value); return *this;} /** *

A filter that returns only components that are part of the specified trial. * If you specify TrialName, you can't filter by * ExperimentName or SourceArn.

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

A filter that returns only components that are part of the specified trial. * If you specify TrialName, you can't filter by * ExperimentName or SourceArn.

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

A filter that returns only components that are part of the specified trial. * If you specify TrialName, you can't filter by * ExperimentName or SourceArn.

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

A filter that returns only components that are part of the specified trial. * If you specify TrialName, you can't filter by * ExperimentName or SourceArn.

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

A filter that returns only components that are part of the specified trial. * If you specify TrialName, you can't filter by * ExperimentName or SourceArn.

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

A filter that returns only components that are part of the specified trial. * If you specify TrialName, you can't filter by * ExperimentName or SourceArn.

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

A filter that returns only components that are part of the specified trial. * If you specify TrialName, you can't filter by * ExperimentName or SourceArn.

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

A filter that returns only components that are part of the specified trial. * If you specify TrialName, you can't filter by * ExperimentName or SourceArn.

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

A filter that returns only components that have the specified source Amazon * Resource Name (ARN). If you specify SourceArn, you can't filter by * ExperimentName or TrialName.

*/ inline const Aws::String& GetSourceArn() const{ return m_sourceArn; } /** *

A filter that returns only components that have the specified source Amazon * Resource Name (ARN). If you specify SourceArn, you can't filter by * ExperimentName or TrialName.

*/ inline bool SourceArnHasBeenSet() const { return m_sourceArnHasBeenSet; } /** *

A filter that returns only components that have the specified source Amazon * Resource Name (ARN). If you specify SourceArn, you can't filter by * ExperimentName or TrialName.

*/ inline void SetSourceArn(const Aws::String& value) { m_sourceArnHasBeenSet = true; m_sourceArn = value; } /** *

A filter that returns only components that have the specified source Amazon * Resource Name (ARN). If you specify SourceArn, you can't filter by * ExperimentName or TrialName.

*/ inline void SetSourceArn(Aws::String&& value) { m_sourceArnHasBeenSet = true; m_sourceArn = std::move(value); } /** *

A filter that returns only components that have the specified source Amazon * Resource Name (ARN). If you specify SourceArn, you can't filter by * ExperimentName or TrialName.

*/ inline void SetSourceArn(const char* value) { m_sourceArnHasBeenSet = true; m_sourceArn.assign(value); } /** *

A filter that returns only components that have the specified source Amazon * Resource Name (ARN). If you specify SourceArn, you can't filter by * ExperimentName or TrialName.

*/ inline ListTrialComponentsRequest& WithSourceArn(const Aws::String& value) { SetSourceArn(value); return *this;} /** *

A filter that returns only components that have the specified source Amazon * Resource Name (ARN). If you specify SourceArn, you can't filter by * ExperimentName or TrialName.

*/ inline ListTrialComponentsRequest& WithSourceArn(Aws::String&& value) { SetSourceArn(std::move(value)); return *this;} /** *

A filter that returns only components that have the specified source Amazon * Resource Name (ARN). If you specify SourceArn, you can't filter by * ExperimentName or TrialName.

*/ inline ListTrialComponentsRequest& WithSourceArn(const char* value) { SetSourceArn(value); return *this;} /** *

A filter that returns only components created after the specified time.

*/ inline const Aws::Utils::DateTime& GetCreatedAfter() const{ return m_createdAfter; } /** *

A filter that returns only components created after the specified time.

*/ inline bool CreatedAfterHasBeenSet() const { return m_createdAfterHasBeenSet; } /** *

A filter that returns only components created after the specified time.

*/ inline void SetCreatedAfter(const Aws::Utils::DateTime& value) { m_createdAfterHasBeenSet = true; m_createdAfter = value; } /** *

A filter that returns only components created after the specified time.

*/ inline void SetCreatedAfter(Aws::Utils::DateTime&& value) { m_createdAfterHasBeenSet = true; m_createdAfter = std::move(value); } /** *

A filter that returns only components created after the specified time.

*/ inline ListTrialComponentsRequest& WithCreatedAfter(const Aws::Utils::DateTime& value) { SetCreatedAfter(value); return *this;} /** *

A filter that returns only components created after the specified time.

*/ inline ListTrialComponentsRequest& WithCreatedAfter(Aws::Utils::DateTime&& value) { SetCreatedAfter(std::move(value)); return *this;} /** *

A filter that returns only components created before the specified time.

*/ inline const Aws::Utils::DateTime& GetCreatedBefore() const{ return m_createdBefore; } /** *

A filter that returns only components created before the specified time.

*/ inline bool CreatedBeforeHasBeenSet() const { return m_createdBeforeHasBeenSet; } /** *

A filter that returns only components created before the specified time.

*/ inline void SetCreatedBefore(const Aws::Utils::DateTime& value) { m_createdBeforeHasBeenSet = true; m_createdBefore = value; } /** *

A filter that returns only components created before the specified time.

*/ inline void SetCreatedBefore(Aws::Utils::DateTime&& value) { m_createdBeforeHasBeenSet = true; m_createdBefore = std::move(value); } /** *

A filter that returns only components created before the specified time.

*/ inline ListTrialComponentsRequest& WithCreatedBefore(const Aws::Utils::DateTime& value) { SetCreatedBefore(value); return *this;} /** *

A filter that returns only components created before the specified time.

*/ inline ListTrialComponentsRequest& WithCreatedBefore(Aws::Utils::DateTime&& value) { SetCreatedBefore(std::move(value)); return *this;} /** *

The property used to sort results. The default value is * CreationTime.

*/ inline const SortTrialComponentsBy& GetSortBy() const{ return m_sortBy; } /** *

The property used to sort results. The default value is * CreationTime.

*/ inline bool SortByHasBeenSet() const { return m_sortByHasBeenSet; } /** *

The property used to sort results. The default value is * CreationTime.

*/ inline void SetSortBy(const SortTrialComponentsBy& value) { m_sortByHasBeenSet = true; m_sortBy = value; } /** *

The property used to sort results. The default value is * CreationTime.

*/ inline void SetSortBy(SortTrialComponentsBy&& value) { m_sortByHasBeenSet = true; m_sortBy = std::move(value); } /** *

The property used to sort results. The default value is * CreationTime.

*/ inline ListTrialComponentsRequest& WithSortBy(const SortTrialComponentsBy& value) { SetSortBy(value); return *this;} /** *

The property used to sort results. The default value is * CreationTime.

*/ inline ListTrialComponentsRequest& WithSortBy(SortTrialComponentsBy&& value) { SetSortBy(std::move(value)); return *this;} /** *

The sort order. The default value is Descending.

*/ inline const SortOrder& GetSortOrder() const{ return m_sortOrder; } /** *

The sort order. The default value is Descending.

*/ inline bool SortOrderHasBeenSet() const { return m_sortOrderHasBeenSet; } /** *

The sort order. The default value is Descending.

*/ inline void SetSortOrder(const SortOrder& value) { m_sortOrderHasBeenSet = true; m_sortOrder = value; } /** *

The sort order. The default value is Descending.

*/ inline void SetSortOrder(SortOrder&& value) { m_sortOrderHasBeenSet = true; m_sortOrder = std::move(value); } /** *

The sort order. The default value is Descending.

*/ inline ListTrialComponentsRequest& WithSortOrder(const SortOrder& value) { SetSortOrder(value); return *this;} /** *

The sort order. The default value is Descending.

*/ inline ListTrialComponentsRequest& WithSortOrder(SortOrder&& value) { SetSortOrder(std::move(value)); return *this;} /** *

The maximum number of components to return in the response. The default value * is 10.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of components to return in the response. The default value * is 10.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of components to return in the response. The default value * is 10.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of components to return in the response. The default value * is 10.

*/ inline ListTrialComponentsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

If the previous call to ListTrialComponents didn't return the * full set of components, the call returns a token for getting the next set of * components.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

If the previous call to ListTrialComponents didn't return the * full set of components, the call returns a token for getting the next set of * components.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

If the previous call to ListTrialComponents didn't return the * full set of components, the call returns a token for getting the next set of * components.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

If the previous call to ListTrialComponents didn't return the * full set of components, the call returns a token for getting the next set of * components.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

If the previous call to ListTrialComponents didn't return the * full set of components, the call returns a token for getting the next set of * components.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

If the previous call to ListTrialComponents didn't return the * full set of components, the call returns a token for getting the next set of * components.

*/ inline ListTrialComponentsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

If the previous call to ListTrialComponents didn't return the * full set of components, the call returns a token for getting the next set of * components.

*/ inline ListTrialComponentsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

If the previous call to ListTrialComponents didn't return the * full set of components, the call returns a token for getting the next set of * components.

*/ inline ListTrialComponentsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::String m_experimentName; bool m_experimentNameHasBeenSet = false; Aws::String m_trialName; bool m_trialNameHasBeenSet = false; Aws::String m_sourceArn; bool m_sourceArnHasBeenSet = false; Aws::Utils::DateTime m_createdAfter; bool m_createdAfterHasBeenSet = false; Aws::Utils::DateTime m_createdBefore; bool m_createdBeforeHasBeenSet = false; SortTrialComponentsBy m_sortBy; bool m_sortByHasBeenSet = false; SortOrder m_sortOrder; bool m_sortOrderHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws