AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::AlexaForBusiness::Model::SearchProfilesRequest Class Reference

#include <SearchProfilesRequest.h>

+ Inheritance diagram for Aws::AlexaForBusiness::Model::SearchProfilesRequest:

Public Member Functions

 SearchProfilesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
SearchProfilesRequestWithNextToken (const Aws::String &value)
 
SearchProfilesRequestWithNextToken (Aws::String &&value)
 
SearchProfilesRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
SearchProfilesRequestWithMaxResults (int value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
SearchProfilesRequestWithFilters (const Aws::Vector< Filter > &value)
 
SearchProfilesRequestWithFilters (Aws::Vector< Filter > &&value)
 
SearchProfilesRequestAddFilters (const Filter &value)
 
SearchProfilesRequestAddFilters (Filter &&value)
 
const Aws::Vector< Sort > & GetSortCriteria () const
 
bool SortCriteriaHasBeenSet () const
 
void SetSortCriteria (const Aws::Vector< Sort > &value)
 
void SetSortCriteria (Aws::Vector< Sort > &&value)
 
SearchProfilesRequestWithSortCriteria (const Aws::Vector< Sort > &value)
 
SearchProfilesRequestWithSortCriteria (Aws::Vector< Sort > &&value)
 
SearchProfilesRequestAddSortCriteria (const Sort &value)
 
SearchProfilesRequestAddSortCriteria (Sort &&value)
 
- Public Member Functions inherited from Aws::AlexaForBusiness::AlexaForBusinessRequest
virtual ~AlexaForBusinessRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file SearchProfilesRequest.h.

Constructor & Destructor Documentation

◆ SearchProfilesRequest()

Aws::AlexaForBusiness::Model::SearchProfilesRequest::SearchProfilesRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::AddFilters ( const Filter value)
inline

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Definition at line 174 of file SearchProfilesRequest.h.

◆ AddFilters() [2/2]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::AddFilters ( Filter &&  value)
inline

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Definition at line 180 of file SearchProfilesRequest.h.

◆ AddSortCriteria() [1/2]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::AddSortCriteria ( const Sort value)
inline

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Definition at line 223 of file SearchProfilesRequest.h.

◆ AddSortCriteria() [2/2]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::AddSortCriteria ( Sort &&  value)
inline

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Definition at line 229 of file SearchProfilesRequest.h.

◆ FiltersHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchProfilesRequest::FiltersHasBeenSet ( ) const
inline

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Definition at line 144 of file SearchProfilesRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::AlexaForBusiness::Model::SearchProfilesRequest::GetFilters ( ) const
inline

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Definition at line 138 of file SearchProfilesRequest.h.

◆ GetMaxResults()

int Aws::AlexaForBusiness::Model::SearchProfilesRequest::GetMaxResults ( ) const
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 110 of file SearchProfilesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::AlexaForBusiness::Model::SearchProfilesRequest::GetNextToken ( ) const
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 46 of file SearchProfilesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::AlexaForBusiness::Model::SearchProfilesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::AlexaForBusiness::Model::SearchProfilesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SearchProfilesRequest.h.

◆ GetSortCriteria()

const Aws::Vector<Sort>& Aws::AlexaForBusiness::Model::SearchProfilesRequest::GetSortCriteria ( ) const
inline

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Definition at line 187 of file SearchProfilesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchProfilesRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 117 of file SearchProfilesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchProfilesRequest::NextTokenHasBeenSet ( ) const
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 54 of file SearchProfilesRequest.h.

◆ SerializePayload()

Aws::String Aws::AlexaForBusiness::Model::SearchProfilesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::AlexaForBusiness::Model::SearchProfilesRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Definition at line 150 of file SearchProfilesRequest.h.

◆ SetFilters() [2/2]

void Aws::AlexaForBusiness::Model::SearchProfilesRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Definition at line 156 of file SearchProfilesRequest.h.

◆ SetMaxResults()

void Aws::AlexaForBusiness::Model::SearchProfilesRequest::SetMaxResults ( int  value)
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 124 of file SearchProfilesRequest.h.

◆ SetNextToken() [1/3]

void Aws::AlexaForBusiness::Model::SearchProfilesRequest::SetNextToken ( const Aws::String value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 62 of file SearchProfilesRequest.h.

◆ SetNextToken() [2/3]

void Aws::AlexaForBusiness::Model::SearchProfilesRequest::SetNextToken ( Aws::String &&  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 70 of file SearchProfilesRequest.h.

◆ SetNextToken() [3/3]

void Aws::AlexaForBusiness::Model::SearchProfilesRequest::SetNextToken ( const char *  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 78 of file SearchProfilesRequest.h.

◆ SetSortCriteria() [1/2]

void Aws::AlexaForBusiness::Model::SearchProfilesRequest::SetSortCriteria ( const Aws::Vector< Sort > &  value)
inline

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Definition at line 199 of file SearchProfilesRequest.h.

◆ SetSortCriteria() [2/2]

void Aws::AlexaForBusiness::Model::SearchProfilesRequest::SetSortCriteria ( Aws::Vector< Sort > &&  value)
inline

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Definition at line 205 of file SearchProfilesRequest.h.

◆ SortCriteriaHasBeenSet()

bool Aws::AlexaForBusiness::Model::SearchProfilesRequest::SortCriteriaHasBeenSet ( ) const
inline

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Definition at line 193 of file SearchProfilesRequest.h.

◆ WithFilters() [1/2]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Definition at line 162 of file SearchProfilesRequest.h.

◆ WithFilters() [2/2]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

Definition at line 168 of file SearchProfilesRequest.h.

◆ WithMaxResults()

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::WithMaxResults ( int  value)
inline

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Definition at line 131 of file SearchProfilesRequest.h.

◆ WithNextToken() [1/3]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::WithNextToken ( const Aws::String value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 86 of file SearchProfilesRequest.h.

◆ WithNextToken() [2/3]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::WithNextToken ( Aws::String &&  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 94 of file SearchProfilesRequest.h.

◆ WithNextToken() [3/3]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::WithNextToken ( const char *  value)
inline

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Definition at line 102 of file SearchProfilesRequest.h.

◆ WithSortCriteria() [1/2]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::WithSortCriteria ( const Aws::Vector< Sort > &  value)
inline

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Definition at line 211 of file SearchProfilesRequest.h.

◆ WithSortCriteria() [2/2]

SearchProfilesRequest& Aws::AlexaForBusiness::Model::SearchProfilesRequest::WithSortCriteria ( Aws::Vector< Sort > &&  value)
inline

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Definition at line 217 of file SearchProfilesRequest.h.


The documentation for this class was generated from the following file: