/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace ResourceExplorer2 { namespace Model { /** */ class SearchRequest : public ResourceExplorer2Request { public: AWS_RESOURCEEXPLORER2_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_RESOURCEEXPLORER2_API Aws::String SerializePayload() const override; /** *

The maximum number of results that you want included on each page of the * response. If you do not include this parameter, it defaults to a value * appropriate to the operation. If additional items exist beyond those included in * the current response, the NextToken response element is present and * has a value (is not null). Include that value as the NextToken * request parameter in the next call to the operation to get the next part of the * results.

An API operation can return fewer results than the * maximum even when there are more results available. You should check * NextToken after every operation to ensure that you receive all of * the results.

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

The maximum number of results that you want included on each page of the * response. If you do not include this parameter, it defaults to a value * appropriate to the operation. If additional items exist beyond those included in * the current response, the NextToken response element is present and * has a value (is not null). Include that value as the NextToken * request parameter in the next call to the operation to get the next part of the * results.

An API operation can return fewer results than the * maximum even when there are more results available. You should check * NextToken after every operation to ensure that you receive all of * the results.

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

The maximum number of results that you want included on each page of the * response. If you do not include this parameter, it defaults to a value * appropriate to the operation. If additional items exist beyond those included in * the current response, the NextToken response element is present and * has a value (is not null). Include that value as the NextToken * request parameter in the next call to the operation to get the next part of the * results.

An API operation can return fewer results than the * maximum even when there are more results available. You should check * NextToken after every operation to ensure that you receive all of * the results.

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

The maximum number of results that you want included on each page of the * response. If you do not include this parameter, it defaults to a value * appropriate to the operation. If additional items exist beyond those included in * the current response, the NextToken response element is present and * has a value (is not null). Include that value as the NextToken * request parameter in the next call to the operation to get the next part of the * results.

An API operation can return fewer results than the * maximum even when there are more results available. You should check * NextToken after every operation to ensure that you receive all of * the results.

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

The parameter for receiving additional results if you receive a * NextToken response in a previous request. A NextToken * response indicates that more output is available. Set this parameter to the * value of the previous call's NextToken response to indicate where * the output should continue from.

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

The parameter for receiving additional results if you receive a * NextToken response in a previous request. A NextToken * response indicates that more output is available. Set this parameter to the * value of the previous call's NextToken response to indicate where * the output should continue from.

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

The parameter for receiving additional results if you receive a * NextToken response in a previous request. A NextToken * response indicates that more output is available. Set this parameter to the * value of the previous call's NextToken response to indicate where * the output should continue from.

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

The parameter for receiving additional results if you receive a * NextToken response in a previous request. A NextToken * response indicates that more output is available. Set this parameter to the * value of the previous call's NextToken response to indicate where * the output should continue from.

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

The parameter for receiving additional results if you receive a * NextToken response in a previous request. A NextToken * response indicates that more output is available. Set this parameter to the * value of the previous call's NextToken response to indicate where * the output should continue from.

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

The parameter for receiving additional results if you receive a * NextToken response in a previous request. A NextToken * response indicates that more output is available. Set this parameter to the * value of the previous call's NextToken response to indicate where * the output should continue from.

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

The parameter for receiving additional results if you receive a * NextToken response in a previous request. A NextToken * response indicates that more output is available. Set this parameter to the * value of the previous call's NextToken response to indicate where * the output should continue from.

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

The parameter for receiving additional results if you receive a * NextToken response in a previous request. A NextToken * response indicates that more output is available. Set this parameter to the * value of the previous call's NextToken response to indicate where * the output should continue from.

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

A string that includes keywords and filters that specify the resources that * you want to include in the results.

For the complete syntax supported by * the QueryString parameter, see Search * query syntax reference for Resource Explorer.

The search is * completely case insensitive. You can specify an empty string to return all * results up to the limit of 1,000 total results.

The operation can * return only the first 1,000 results. If the resource you want is not included, * then use a different value for QueryString to refine the * results.

*/ inline const Aws::String& GetQueryString() const{ return m_queryString; } /** *

A string that includes keywords and filters that specify the resources that * you want to include in the results.

For the complete syntax supported by * the QueryString parameter, see Search * query syntax reference for Resource Explorer.

The search is * completely case insensitive. You can specify an empty string to return all * results up to the limit of 1,000 total results.

The operation can * return only the first 1,000 results. If the resource you want is not included, * then use a different value for QueryString to refine the * results.

*/ inline bool QueryStringHasBeenSet() const { return m_queryStringHasBeenSet; } /** *

A string that includes keywords and filters that specify the resources that * you want to include in the results.

For the complete syntax supported by * the QueryString parameter, see Search * query syntax reference for Resource Explorer.

The search is * completely case insensitive. You can specify an empty string to return all * results up to the limit of 1,000 total results.

The operation can * return only the first 1,000 results. If the resource you want is not included, * then use a different value for QueryString to refine the * results.

*/ inline void SetQueryString(const Aws::String& value) { m_queryStringHasBeenSet = true; m_queryString = value; } /** *

A string that includes keywords and filters that specify the resources that * you want to include in the results.

For the complete syntax supported by * the QueryString parameter, see Search * query syntax reference for Resource Explorer.

The search is * completely case insensitive. You can specify an empty string to return all * results up to the limit of 1,000 total results.

The operation can * return only the first 1,000 results. If the resource you want is not included, * then use a different value for QueryString to refine the * results.

*/ inline void SetQueryString(Aws::String&& value) { m_queryStringHasBeenSet = true; m_queryString = std::move(value); } /** *

A string that includes keywords and filters that specify the resources that * you want to include in the results.

For the complete syntax supported by * the QueryString parameter, see Search * query syntax reference for Resource Explorer.

The search is * completely case insensitive. You can specify an empty string to return all * results up to the limit of 1,000 total results.

The operation can * return only the first 1,000 results. If the resource you want is not included, * then use a different value for QueryString to refine the * results.

*/ inline void SetQueryString(const char* value) { m_queryStringHasBeenSet = true; m_queryString.assign(value); } /** *

A string that includes keywords and filters that specify the resources that * you want to include in the results.

For the complete syntax supported by * the QueryString parameter, see Search * query syntax reference for Resource Explorer.

The search is * completely case insensitive. You can specify an empty string to return all * results up to the limit of 1,000 total results.

The operation can * return only the first 1,000 results. If the resource you want is not included, * then use a different value for QueryString to refine the * results.

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

A string that includes keywords and filters that specify the resources that * you want to include in the results.

For the complete syntax supported by * the QueryString parameter, see Search * query syntax reference for Resource Explorer.

The search is * completely case insensitive. You can specify an empty string to return all * results up to the limit of 1,000 total results.

The operation can * return only the first 1,000 results. If the resource you want is not included, * then use a different value for QueryString to refine the * results.

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

A string that includes keywords and filters that specify the resources that * you want to include in the results.

For the complete syntax supported by * the QueryString parameter, see Search * query syntax reference for Resource Explorer.

The search is * completely case insensitive. You can specify an empty string to return all * results up to the limit of 1,000 total results.

The operation can * return only the first 1,000 results. If the resource you want is not included, * then use a different value for QueryString to refine the * results.

*/ inline SearchRequest& WithQueryString(const char* value) { SetQueryString(value); return *this;} /** *

Specifies the Amazon * resource name (ARN) of the view to use for the query. If you don't specify a * value for this parameter, then the operation automatically uses the default view * for the Amazon Web Services Region in which you called this operation. If the * Region either doesn't have a default view or if you don't have permission to use * the default view, then the operation fails with a 401 Unauthorized * exception.

*/ inline const Aws::String& GetViewArn() const{ return m_viewArn; } /** *

Specifies the Amazon * resource name (ARN) of the view to use for the query. If you don't specify a * value for this parameter, then the operation automatically uses the default view * for the Amazon Web Services Region in which you called this operation. If the * Region either doesn't have a default view or if you don't have permission to use * the default view, then the operation fails with a 401 Unauthorized * exception.

*/ inline bool ViewArnHasBeenSet() const { return m_viewArnHasBeenSet; } /** *

Specifies the Amazon * resource name (ARN) of the view to use for the query. If you don't specify a * value for this parameter, then the operation automatically uses the default view * for the Amazon Web Services Region in which you called this operation. If the * Region either doesn't have a default view or if you don't have permission to use * the default view, then the operation fails with a 401 Unauthorized * exception.

*/ inline void SetViewArn(const Aws::String& value) { m_viewArnHasBeenSet = true; m_viewArn = value; } /** *

Specifies the Amazon * resource name (ARN) of the view to use for the query. If you don't specify a * value for this parameter, then the operation automatically uses the default view * for the Amazon Web Services Region in which you called this operation. If the * Region either doesn't have a default view or if you don't have permission to use * the default view, then the operation fails with a 401 Unauthorized * exception.

*/ inline void SetViewArn(Aws::String&& value) { m_viewArnHasBeenSet = true; m_viewArn = std::move(value); } /** *

Specifies the Amazon * resource name (ARN) of the view to use for the query. If you don't specify a * value for this parameter, then the operation automatically uses the default view * for the Amazon Web Services Region in which you called this operation. If the * Region either doesn't have a default view or if you don't have permission to use * the default view, then the operation fails with a 401 Unauthorized * exception.

*/ inline void SetViewArn(const char* value) { m_viewArnHasBeenSet = true; m_viewArn.assign(value); } /** *

Specifies the Amazon * resource name (ARN) of the view to use for the query. If you don't specify a * value for this parameter, then the operation automatically uses the default view * for the Amazon Web Services Region in which you called this operation. If the * Region either doesn't have a default view or if you don't have permission to use * the default view, then the operation fails with a 401 Unauthorized * exception.

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

Specifies the Amazon * resource name (ARN) of the view to use for the query. If you don't specify a * value for this parameter, then the operation automatically uses the default view * for the Amazon Web Services Region in which you called this operation. If the * Region either doesn't have a default view or if you don't have permission to use * the default view, then the operation fails with a 401 Unauthorized * exception.

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

Specifies the Amazon * resource name (ARN) of the view to use for the query. If you don't specify a * value for this parameter, then the operation automatically uses the default view * for the Amazon Web Services Region in which you called this operation. If the * Region either doesn't have a default view or if you don't have permission to use * the default view, then the operation fails with a 401 Unauthorized * exception.

*/ inline SearchRequest& WithViewArn(const char* value) { SetViewArn(value); return *this;} private: int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; Aws::String m_queryString; bool m_queryStringHasBeenSet = false; Aws::String m_viewArn; bool m_viewArnHasBeenSet = false; }; } // namespace Model } // namespace ResourceExplorer2 } // namespace Aws