/** * 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 namespace Aws { namespace SageMaker { namespace Model { /** */ class SearchRequest : public SageMakerRequest { public: AWS_SAGEMAKER_API SearchRequest(); // 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 "Search"; } AWS_SAGEMAKER_API Aws::String SerializePayload() const override; AWS_SAGEMAKER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the SageMaker resource to search for.

*/ inline const ResourceType& GetResource() const{ return m_resource; } /** *

The name of the SageMaker resource to search for.

*/ inline bool ResourceHasBeenSet() const { return m_resourceHasBeenSet; } /** *

The name of the SageMaker resource to search for.

*/ inline void SetResource(const ResourceType& value) { m_resourceHasBeenSet = true; m_resource = value; } /** *

The name of the SageMaker resource to search for.

*/ inline void SetResource(ResourceType&& value) { m_resourceHasBeenSet = true; m_resource = std::move(value); } /** *

The name of the SageMaker resource to search for.

*/ inline SearchRequest& WithResource(const ResourceType& value) { SetResource(value); return *this;} /** *

The name of the SageMaker resource to search for.

*/ inline SearchRequest& WithResource(ResourceType&& value) { SetResource(std::move(value)); return *this;} /** *

A Boolean conditional statement. Resources must satisfy this condition to be * included in search results. You must provide at least one subexpression, filter, * or nested filter. The maximum number of recursive SubExpressions, * NestedFilters, and Filters that can be included in a * SearchExpression object is 50.

*/ inline const SearchExpression& GetSearchExpression() const{ return m_searchExpression; } /** *

A Boolean conditional statement. Resources must satisfy this condition to be * included in search results. You must provide at least one subexpression, filter, * or nested filter. The maximum number of recursive SubExpressions, * NestedFilters, and Filters that can be included in a * SearchExpression object is 50.

*/ inline bool SearchExpressionHasBeenSet() const { return m_searchExpressionHasBeenSet; } /** *

A Boolean conditional statement. Resources must satisfy this condition to be * included in search results. You must provide at least one subexpression, filter, * or nested filter. The maximum number of recursive SubExpressions, * NestedFilters, and Filters that can be included in a * SearchExpression object is 50.

*/ inline void SetSearchExpression(const SearchExpression& value) { m_searchExpressionHasBeenSet = true; m_searchExpression = value; } /** *

A Boolean conditional statement. Resources must satisfy this condition to be * included in search results. You must provide at least one subexpression, filter, * or nested filter. The maximum number of recursive SubExpressions, * NestedFilters, and Filters that can be included in a * SearchExpression object is 50.

*/ inline void SetSearchExpression(SearchExpression&& value) { m_searchExpressionHasBeenSet = true; m_searchExpression = std::move(value); } /** *

A Boolean conditional statement. Resources must satisfy this condition to be * included in search results. You must provide at least one subexpression, filter, * or nested filter. The maximum number of recursive SubExpressions, * NestedFilters, and Filters that can be included in a * SearchExpression object is 50.

*/ inline SearchRequest& WithSearchExpression(const SearchExpression& value) { SetSearchExpression(value); return *this;} /** *

A Boolean conditional statement. Resources must satisfy this condition to be * included in search results. You must provide at least one subexpression, filter, * or nested filter. The maximum number of recursive SubExpressions, * NestedFilters, and Filters that can be included in a * SearchExpression object is 50.

*/ inline SearchRequest& WithSearchExpression(SearchExpression&& value) { SetSearchExpression(std::move(value)); return *this;} /** *

The name of the resource property used to sort the * SearchResults. The default is LastModifiedTime.

*/ inline const Aws::String& GetSortBy() const{ return m_sortBy; } /** *

The name of the resource property used to sort the * SearchResults. The default is LastModifiedTime.

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

The name of the resource property used to sort the * SearchResults. The default is LastModifiedTime.

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

The name of the resource property used to sort the * SearchResults. The default is LastModifiedTime.

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

The name of the resource property used to sort the * SearchResults. The default is LastModifiedTime.

*/ inline void SetSortBy(const char* value) { m_sortByHasBeenSet = true; m_sortBy.assign(value); } /** *

The name of the resource property used to sort the * SearchResults. The default is LastModifiedTime.

*/ inline SearchRequest& WithSortBy(const Aws::String& value) { SetSortBy(value); return *this;} /** *

The name of the resource property used to sort the * SearchResults. The default is LastModifiedTime.

*/ inline SearchRequest& WithSortBy(Aws::String&& value) { SetSortBy(std::move(value)); return *this;} /** *

The name of the resource property used to sort the * SearchResults. The default is LastModifiedTime.

*/ inline SearchRequest& WithSortBy(const char* value) { SetSortBy(value); return *this;} /** *

How SearchResults are ordered. Valid values are * Ascending or Descending. The default is * Descending.

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

How SearchResults are ordered. Valid values are * Ascending or Descending. The default is * Descending.

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

How SearchResults are ordered. Valid values are * Ascending or Descending. The default is * Descending.

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

How SearchResults are ordered. Valid values are * Ascending or Descending. The default is * Descending.

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

How SearchResults are ordered. Valid values are * Ascending or Descending. The default is * Descending.

*/ inline SearchRequest& WithSortOrder(const SearchSortOrder& value) { SetSortOrder(value); return *this;} /** *

How SearchResults are ordered. Valid values are * Ascending or Descending. The default is * Descending.

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

If more than MaxResults resources match the specified * SearchExpression, the response includes a NextToken. * The NextToken can be passed to the next SearchRequest * to continue retrieving results.

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

If more than MaxResults resources match the specified * SearchExpression, the response includes a NextToken. * The NextToken can be passed to the next SearchRequest * to continue retrieving results.

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

If more than MaxResults resources match the specified * SearchExpression, the response includes a NextToken. * The NextToken can be passed to the next SearchRequest * to continue retrieving results.

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

If more than MaxResults resources match the specified * SearchExpression, the response includes a NextToken. * The NextToken can be passed to the next SearchRequest * to continue retrieving results.

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

If more than MaxResults resources match the specified * SearchExpression, the response includes a NextToken. * The NextToken can be passed to the next SearchRequest * to continue retrieving results.

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

If more than MaxResults resources match the specified * SearchExpression, the response includes a NextToken. * The NextToken can be passed to the next SearchRequest * to continue retrieving results.

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

If more than MaxResults resources match the specified * SearchExpression, the response includes a NextToken. * The NextToken can be passed to the next SearchRequest * to continue retrieving results.

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

If more than MaxResults resources match the specified * SearchExpression, the response includes a NextToken. * The NextToken can be passed to the next SearchRequest * to continue retrieving results.

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

The maximum number of results to return.

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

The maximum number of results to return.

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

The maximum number of results to return.

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

The maximum number of results to return.

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

A cross account filter option. When the value is "CrossAccount" * the search results will only include resources made discoverable to you from * other accounts. When the value is "SameAccount" or * null the search results will only include resources from your * account. Default is null. For more information on searching for * resources made discoverable to your account, see * Search discoverable resources in the SageMaker Developer Guide. The maximum * number of ResourceCatalogs viewable is 1000.

*/ inline const CrossAccountFilterOption& GetCrossAccountFilterOption() const{ return m_crossAccountFilterOption; } /** *

A cross account filter option. When the value is "CrossAccount" * the search results will only include resources made discoverable to you from * other accounts. When the value is "SameAccount" or * null the search results will only include resources from your * account. Default is null. For more information on searching for * resources made discoverable to your account, see * Search discoverable resources in the SageMaker Developer Guide. The maximum * number of ResourceCatalogs viewable is 1000.

*/ inline bool CrossAccountFilterOptionHasBeenSet() const { return m_crossAccountFilterOptionHasBeenSet; } /** *

A cross account filter option. When the value is "CrossAccount" * the search results will only include resources made discoverable to you from * other accounts. When the value is "SameAccount" or * null the search results will only include resources from your * account. Default is null. For more information on searching for * resources made discoverable to your account, see * Search discoverable resources in the SageMaker Developer Guide. The maximum * number of ResourceCatalogs viewable is 1000.

*/ inline void SetCrossAccountFilterOption(const CrossAccountFilterOption& value) { m_crossAccountFilterOptionHasBeenSet = true; m_crossAccountFilterOption = value; } /** *

A cross account filter option. When the value is "CrossAccount" * the search results will only include resources made discoverable to you from * other accounts. When the value is "SameAccount" or * null the search results will only include resources from your * account. Default is null. For more information on searching for * resources made discoverable to your account, see * Search discoverable resources in the SageMaker Developer Guide. The maximum * number of ResourceCatalogs viewable is 1000.

*/ inline void SetCrossAccountFilterOption(CrossAccountFilterOption&& value) { m_crossAccountFilterOptionHasBeenSet = true; m_crossAccountFilterOption = std::move(value); } /** *

A cross account filter option. When the value is "CrossAccount" * the search results will only include resources made discoverable to you from * other accounts. When the value is "SameAccount" or * null the search results will only include resources from your * account. Default is null. For more information on searching for * resources made discoverable to your account, see * Search discoverable resources in the SageMaker Developer Guide. The maximum * number of ResourceCatalogs viewable is 1000.

*/ inline SearchRequest& WithCrossAccountFilterOption(const CrossAccountFilterOption& value) { SetCrossAccountFilterOption(value); return *this;} /** *

A cross account filter option. When the value is "CrossAccount" * the search results will only include resources made discoverable to you from * other accounts. When the value is "SameAccount" or * null the search results will only include resources from your * account. Default is null. For more information on searching for * resources made discoverable to your account, see * Search discoverable resources in the SageMaker Developer Guide. The maximum * number of ResourceCatalogs viewable is 1000.

*/ inline SearchRequest& WithCrossAccountFilterOption(CrossAccountFilterOption&& value) { SetCrossAccountFilterOption(std::move(value)); return *this;} private: ResourceType m_resource; bool m_resourceHasBeenSet = false; SearchExpression m_searchExpression; bool m_searchExpressionHasBeenSet = false; Aws::String m_sortBy; bool m_sortByHasBeenSet = false; SearchSortOrder m_sortOrder; bool m_sortOrderHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; CrossAccountFilterOption m_crossAccountFilterOption; bool m_crossAccountFilterOptionHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws