/** * 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 ListModelsRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API ListModelsRequest(); // 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 "ListModels"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

Sorts the list of results. The default is CreationTime.

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

Sorts the list of results. The default is CreationTime.

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

Sorts the list of results. The default is CreationTime.

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

Sorts the list of results. The default is CreationTime.

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

Sorts the list of results. The default is CreationTime.

*/ inline ListModelsRequest& WithSortBy(const ModelSortKey& value) { SetSortBy(value); return *this;} /** *

Sorts the list of results. The default is CreationTime.

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

The sort order for results. The default is Descending.

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

The sort order for results. The default is Descending.

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

The sort order for results. The default is Descending.

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

The sort order for results. The default is Descending.

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

The sort order for results. The default is Descending.

*/ inline ListModelsRequest& WithSortOrder(const OrderKey& value) { SetSortOrder(value); return *this;} /** *

The sort order for results. The default is Descending.

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

If the response to a previous ListModels request was truncated, * the response includes a NextToken. To retrieve the next set of * models, use the token in the next request.

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

If the response to a previous ListModels request was truncated, * the response includes a NextToken. To retrieve the next set of * models, use the token in the next request.

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

If the response to a previous ListModels request was truncated, * the response includes a NextToken. To retrieve the next set of * models, use the token in the next request.

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

If the response to a previous ListModels request was truncated, * the response includes a NextToken. To retrieve the next set of * models, use the token in the next request.

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

If the response to a previous ListModels request was truncated, * the response includes a NextToken. To retrieve the next set of * models, use the token in the next request.

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

If the response to a previous ListModels request was truncated, * the response includes a NextToken. To retrieve the next set of * models, use the token in the next request.

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

If the response to a previous ListModels request was truncated, * the response includes a NextToken. To retrieve the next set of * models, use the token in the next request.

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

If the response to a previous ListModels request was truncated, * the response includes a NextToken. To retrieve the next set of * models, use the token in the next request.

*/ inline ListModelsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The maximum number of models to return in the response.

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

The maximum number of models to return in the response.

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

The maximum number of models to return in the response.

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

The maximum number of models to return in the response.

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

A string in the model name. This filter returns only models whose name * contains the specified string.

*/ inline const Aws::String& GetNameContains() const{ return m_nameContains; } /** *

A string in the model name. This filter returns only models whose name * contains the specified string.

*/ inline bool NameContainsHasBeenSet() const { return m_nameContainsHasBeenSet; } /** *

A string in the model name. This filter returns only models whose name * contains the specified string.

*/ inline void SetNameContains(const Aws::String& value) { m_nameContainsHasBeenSet = true; m_nameContains = value; } /** *

A string in the model name. This filter returns only models whose name * contains the specified string.

*/ inline void SetNameContains(Aws::String&& value) { m_nameContainsHasBeenSet = true; m_nameContains = std::move(value); } /** *

A string in the model name. This filter returns only models whose name * contains the specified string.

*/ inline void SetNameContains(const char* value) { m_nameContainsHasBeenSet = true; m_nameContains.assign(value); } /** *

A string in the model name. This filter returns only models whose name * contains the specified string.

*/ inline ListModelsRequest& WithNameContains(const Aws::String& value) { SetNameContains(value); return *this;} /** *

A string in the model name. This filter returns only models whose name * contains the specified string.

*/ inline ListModelsRequest& WithNameContains(Aws::String&& value) { SetNameContains(std::move(value)); return *this;} /** *

A string in the model name. This filter returns only models whose name * contains the specified string.

*/ inline ListModelsRequest& WithNameContains(const char* value) { SetNameContains(value); return *this;} /** *

A filter that returns only models created before the specified time * (timestamp).

*/ inline const Aws::Utils::DateTime& GetCreationTimeBefore() const{ return m_creationTimeBefore; } /** *

A filter that returns only models created before the specified time * (timestamp).

*/ inline bool CreationTimeBeforeHasBeenSet() const { return m_creationTimeBeforeHasBeenSet; } /** *

A filter that returns only models created before the specified time * (timestamp).

*/ inline void SetCreationTimeBefore(const Aws::Utils::DateTime& value) { m_creationTimeBeforeHasBeenSet = true; m_creationTimeBefore = value; } /** *

A filter that returns only models created before the specified time * (timestamp).

*/ inline void SetCreationTimeBefore(Aws::Utils::DateTime&& value) { m_creationTimeBeforeHasBeenSet = true; m_creationTimeBefore = std::move(value); } /** *

A filter that returns only models created before the specified time * (timestamp).

*/ inline ListModelsRequest& WithCreationTimeBefore(const Aws::Utils::DateTime& value) { SetCreationTimeBefore(value); return *this;} /** *

A filter that returns only models created before the specified time * (timestamp).

*/ inline ListModelsRequest& WithCreationTimeBefore(Aws::Utils::DateTime&& value) { SetCreationTimeBefore(std::move(value)); return *this;} /** *

A filter that returns only models with a creation time greater than or equal * to the specified time (timestamp).

*/ inline const Aws::Utils::DateTime& GetCreationTimeAfter() const{ return m_creationTimeAfter; } /** *

A filter that returns only models with a creation time greater than or equal * to the specified time (timestamp).

*/ inline bool CreationTimeAfterHasBeenSet() const { return m_creationTimeAfterHasBeenSet; } /** *

A filter that returns only models with a creation time greater than or equal * to the specified time (timestamp).

*/ inline void SetCreationTimeAfter(const Aws::Utils::DateTime& value) { m_creationTimeAfterHasBeenSet = true; m_creationTimeAfter = value; } /** *

A filter that returns only models with a creation time greater than or equal * to the specified time (timestamp).

*/ inline void SetCreationTimeAfter(Aws::Utils::DateTime&& value) { m_creationTimeAfterHasBeenSet = true; m_creationTimeAfter = std::move(value); } /** *

A filter that returns only models with a creation time greater than or equal * to the specified time (timestamp).

*/ inline ListModelsRequest& WithCreationTimeAfter(const Aws::Utils::DateTime& value) { SetCreationTimeAfter(value); return *this;} /** *

A filter that returns only models with a creation time greater than or equal * to the specified time (timestamp).

*/ inline ListModelsRequest& WithCreationTimeAfter(Aws::Utils::DateTime&& value) { SetCreationTimeAfter(std::move(value)); return *this;} private: ModelSortKey m_sortBy; bool m_sortByHasBeenSet = false; OrderKey m_sortOrder; bool m_sortOrderHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nameContains; bool m_nameContainsHasBeenSet = false; Aws::Utils::DateTime m_creationTimeBefore; bool m_creationTimeBeforeHasBeenSet = false; Aws::Utils::DateTime m_creationTimeAfter; bool m_creationTimeAfterHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws