/** * 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 ConnectCases { namespace Model { /** */ class SearchCasesRequest : public ConnectCasesRequest { public: AWS_CONNECTCASES_API SearchCasesRequest(); // 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 "SearchCases"; } AWS_CONNECTCASES_API Aws::String SerializePayload() const override; /** *

The unique identifier of the Cases domain.

*/ inline const Aws::String& GetDomainId() const{ return m_domainId; } /** *

The unique identifier of the Cases domain.

*/ inline bool DomainIdHasBeenSet() const { return m_domainIdHasBeenSet; } /** *

The unique identifier of the Cases domain.

*/ inline void SetDomainId(const Aws::String& value) { m_domainIdHasBeenSet = true; m_domainId = value; } /** *

The unique identifier of the Cases domain.

*/ inline void SetDomainId(Aws::String&& value) { m_domainIdHasBeenSet = true; m_domainId = std::move(value); } /** *

The unique identifier of the Cases domain.

*/ inline void SetDomainId(const char* value) { m_domainIdHasBeenSet = true; m_domainId.assign(value); } /** *

The unique identifier of the Cases domain.

*/ inline SearchCasesRequest& WithDomainId(const Aws::String& value) { SetDomainId(value); return *this;} /** *

The unique identifier of the Cases domain.

*/ inline SearchCasesRequest& WithDomainId(Aws::String&& value) { SetDomainId(std::move(value)); return *this;} /** *

The unique identifier of the Cases domain.

*/ inline SearchCasesRequest& WithDomainId(const char* value) { SetDomainId(value); return *this;} /** *

The list of field identifiers to be returned as part of the response.

*/ inline const Aws::Vector& GetFields() const{ return m_fields; } /** *

The list of field identifiers to be returned as part of the response.

*/ inline bool FieldsHasBeenSet() const { return m_fieldsHasBeenSet; } /** *

The list of field identifiers to be returned as part of the response.

*/ inline void SetFields(const Aws::Vector& value) { m_fieldsHasBeenSet = true; m_fields = value; } /** *

The list of field identifiers to be returned as part of the response.

*/ inline void SetFields(Aws::Vector&& value) { m_fieldsHasBeenSet = true; m_fields = std::move(value); } /** *

The list of field identifiers to be returned as part of the response.

*/ inline SearchCasesRequest& WithFields(const Aws::Vector& value) { SetFields(value); return *this;} /** *

The list of field identifiers to be returned as part of the response.

*/ inline SearchCasesRequest& WithFields(Aws::Vector&& value) { SetFields(std::move(value)); return *this;} /** *

The list of field identifiers to be returned as part of the response.

*/ inline SearchCasesRequest& AddFields(const FieldIdentifier& value) { m_fieldsHasBeenSet = true; m_fields.push_back(value); return *this; } /** *

The list of field identifiers to be returned as part of the response.

*/ inline SearchCasesRequest& AddFields(FieldIdentifier&& value) { m_fieldsHasBeenSet = true; m_fields.push_back(std::move(value)); return *this; } /** *

A list of filter objects.

*/ inline const CaseFilter& GetFilter() const{ return m_filter; } /** *

A list of filter objects.

*/ inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; } /** *

A list of filter objects.

*/ inline void SetFilter(const CaseFilter& value) { m_filterHasBeenSet = true; m_filter = value; } /** *

A list of filter objects.

*/ inline void SetFilter(CaseFilter&& value) { m_filterHasBeenSet = true; m_filter = std::move(value); } /** *

A list of filter objects.

*/ inline SearchCasesRequest& WithFilter(const CaseFilter& value) { SetFilter(value); return *this;} /** *

A list of filter objects.

*/ inline SearchCasesRequest& WithFilter(CaseFilter&& value) { SetFilter(std::move(value)); return *this;} /** *

The maximum number of cases to return. The current maximum supported value is * 25. This is also the default value when no other value is provided.

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

The maximum number of cases to return. The current maximum supported value is * 25. This is also the default value when no other value is provided.

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

The maximum number of cases to return. The current maximum supported value is * 25. This is also the default value when no other value is provided.

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

The maximum number of cases to return. The current maximum supported value is * 25. This is also the default value when no other value is provided.

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

The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.

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

A word or phrase used to perform a quick search.

*/ inline const Aws::String& GetSearchTerm() const{ return m_searchTerm; } /** *

A word or phrase used to perform a quick search.

*/ inline bool SearchTermHasBeenSet() const { return m_searchTermHasBeenSet; } /** *

A word or phrase used to perform a quick search.

*/ inline void SetSearchTerm(const Aws::String& value) { m_searchTermHasBeenSet = true; m_searchTerm = value; } /** *

A word or phrase used to perform a quick search.

*/ inline void SetSearchTerm(Aws::String&& value) { m_searchTermHasBeenSet = true; m_searchTerm = std::move(value); } /** *

A word or phrase used to perform a quick search.

*/ inline void SetSearchTerm(const char* value) { m_searchTermHasBeenSet = true; m_searchTerm.assign(value); } /** *

A word or phrase used to perform a quick search.

*/ inline SearchCasesRequest& WithSearchTerm(const Aws::String& value) { SetSearchTerm(value); return *this;} /** *

A word or phrase used to perform a quick search.

*/ inline SearchCasesRequest& WithSearchTerm(Aws::String&& value) { SetSearchTerm(std::move(value)); return *this;} /** *

A word or phrase used to perform a quick search.

*/ inline SearchCasesRequest& WithSearchTerm(const char* value) { SetSearchTerm(value); return *this;} /** *

A list of sorts where each sort specifies a field and their sort order to be * applied to the results.

*/ inline const Aws::Vector& GetSorts() const{ return m_sorts; } /** *

A list of sorts where each sort specifies a field and their sort order to be * applied to the results.

*/ inline bool SortsHasBeenSet() const { return m_sortsHasBeenSet; } /** *

A list of sorts where each sort specifies a field and their sort order to be * applied to the results.

*/ inline void SetSorts(const Aws::Vector& value) { m_sortsHasBeenSet = true; m_sorts = value; } /** *

A list of sorts where each sort specifies a field and their sort order to be * applied to the results.

*/ inline void SetSorts(Aws::Vector&& value) { m_sortsHasBeenSet = true; m_sorts = std::move(value); } /** *

A list of sorts where each sort specifies a field and their sort order to be * applied to the results.

*/ inline SearchCasesRequest& WithSorts(const Aws::Vector& value) { SetSorts(value); return *this;} /** *

A list of sorts where each sort specifies a field and their sort order to be * applied to the results.

*/ inline SearchCasesRequest& WithSorts(Aws::Vector&& value) { SetSorts(std::move(value)); return *this;} /** *

A list of sorts where each sort specifies a field and their sort order to be * applied to the results.

*/ inline SearchCasesRequest& AddSorts(const Sort& value) { m_sortsHasBeenSet = true; m_sorts.push_back(value); return *this; } /** *

A list of sorts where each sort specifies a field and their sort order to be * applied to the results.

*/ inline SearchCasesRequest& AddSorts(Sort&& value) { m_sortsHasBeenSet = true; m_sorts.push_back(std::move(value)); return *this; } private: Aws::String m_domainId; bool m_domainIdHasBeenSet = false; Aws::Vector m_fields; bool m_fieldsHasBeenSet = false; CaseFilter m_filter; bool m_filterHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; Aws::String m_searchTerm; bool m_searchTermHasBeenSet = false; Aws::Vector m_sorts; bool m_sortsHasBeenSet = false; }; } // namespace Model } // namespace ConnectCases } // namespace Aws