AWS SDK for C++  1.9.44
AWS SDK for C++
Public Member Functions | List of all members
Aws::ForecastService::Model::ListPredictorsRequest Class Reference

#include <ListPredictorsRequest.h>

+ Inheritance diagram for Aws::ForecastService::Model::ListPredictorsRequest:

Public Member Functions

 ListPredictorsRequest ()
 
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)
 
ListPredictorsRequestWithNextToken (const Aws::String &value)
 
ListPredictorsRequestWithNextToken (Aws::String &&value)
 
ListPredictorsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListPredictorsRequestWithMaxResults (int value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
ListPredictorsRequestWithFilters (const Aws::Vector< Filter > &value)
 
ListPredictorsRequestWithFilters (Aws::Vector< Filter > &&value)
 
ListPredictorsRequestAddFilters (const Filter &value)
 
ListPredictorsRequestAddFilters (Filter &&value)
 
- Public Member Functions inherited from Aws::ForecastService::ForecastServiceRequest
virtual ~ForecastServiceRequest ()
 
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 23 of file ListPredictorsRequest.h.

Constructor & Destructor Documentation

◆ ListPredictorsRequest()

Aws::ForecastService::Model::ListPredictorsRequest::ListPredictorsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

ListPredictorsRequest& Aws::ForecastService::Model::ListPredictorsRequest::AddFilters ( const Filter value)
inline

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.

  • Value - The value to match.

For example, to list all predictors whose status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Definition at line 241 of file ListPredictorsRequest.h.

◆ AddFilters() [2/2]

ListPredictorsRequest& Aws::ForecastService::Model::ListPredictorsRequest::AddFilters ( Filter &&  value)
inline

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.

  • Value - The value to match.

For example, to list all predictors whose status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Definition at line 259 of file ListPredictorsRequest.h.

◆ FiltersHasBeenSet()

bool Aws::ForecastService::Model::ListPredictorsRequest::FiltersHasBeenSet ( ) const
inline

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.

  • Value - The value to match.

For example, to list all predictors whose status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Definition at line 151 of file ListPredictorsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::ForecastService::Model::ListPredictorsRequest::GetFilters ( ) const
inline

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.

  • Value - The value to match.

For example, to list all predictors whose status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Definition at line 133 of file ListPredictorsRequest.h.

◆ GetMaxResults()

int Aws::ForecastService::Model::ListPredictorsRequest::GetMaxResults ( ) const
inline

The number of items to return in the response.

Definition at line 99 of file ListPredictorsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::ForecastService::Model::ListPredictorsRequest::GetNextToken ( ) const
inline

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Definition at line 44 of file ListPredictorsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ForecastService::Model::ListPredictorsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::ForecastService::Model::ListPredictorsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListPredictorsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::ForecastService::Model::ListPredictorsRequest::MaxResultsHasBeenSet ( ) const
inline

The number of items to return in the response.

Definition at line 104 of file ListPredictorsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::ForecastService::Model::ListPredictorsRequest::NextTokenHasBeenSet ( ) const
inline

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Definition at line 51 of file ListPredictorsRequest.h.

◆ SerializePayload()

Aws::String Aws::ForecastService::Model::ListPredictorsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::ForecastService::Model::ListPredictorsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.

  • Value - The value to match.

For example, to list all predictors whose status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Definition at line 187 of file ListPredictorsRequest.h.

◆ SetFilters() [2/2]

void Aws::ForecastService::Model::ListPredictorsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.

  • Value - The value to match.

For example, to list all predictors whose status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Definition at line 169 of file ListPredictorsRequest.h.

◆ SetMaxResults()

void Aws::ForecastService::Model::ListPredictorsRequest::SetMaxResults ( int  value)
inline

The number of items to return in the response.

Definition at line 109 of file ListPredictorsRequest.h.

◆ SetNextToken() [1/3]

void Aws::ForecastService::Model::ListPredictorsRequest::SetNextToken ( Aws::String &&  value)
inline

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Definition at line 65 of file ListPredictorsRequest.h.

◆ SetNextToken() [2/3]

void Aws::ForecastService::Model::ListPredictorsRequest::SetNextToken ( const Aws::String value)
inline

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Definition at line 58 of file ListPredictorsRequest.h.

◆ SetNextToken() [3/3]

void Aws::ForecastService::Model::ListPredictorsRequest::SetNextToken ( const char *  value)
inline

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Definition at line 72 of file ListPredictorsRequest.h.

◆ WithFilters() [1/2]

ListPredictorsRequest& Aws::ForecastService::Model::ListPredictorsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.

  • Value - The value to match.

For example, to list all predictors whose status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Definition at line 223 of file ListPredictorsRequest.h.

◆ WithFilters() [2/2]

ListPredictorsRequest& Aws::ForecastService::Model::ListPredictorsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictors that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

  • Condition - The condition to apply. Valid values are IS and IS_NOT. To include the predictors that match the statement, specify IS. To exclude matching predictors, specify IS_NOT.

  • Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and Status.

  • Value - The value to match.

For example, to list all predictors whose status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Definition at line 205 of file ListPredictorsRequest.h.

◆ WithMaxResults()

ListPredictorsRequest& Aws::ForecastService::Model::ListPredictorsRequest::WithMaxResults ( int  value)
inline

The number of items to return in the response.

Definition at line 114 of file ListPredictorsRequest.h.

◆ WithNextToken() [1/3]

ListPredictorsRequest& Aws::ForecastService::Model::ListPredictorsRequest::WithNextToken ( Aws::String &&  value)
inline

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Definition at line 86 of file ListPredictorsRequest.h.

◆ WithNextToken() [2/3]

ListPredictorsRequest& Aws::ForecastService::Model::ListPredictorsRequest::WithNextToken ( const Aws::String value)
inline

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Definition at line 79 of file ListPredictorsRequest.h.

◆ WithNextToken() [3/3]

ListPredictorsRequest& Aws::ForecastService::Model::ListPredictorsRequest::WithNextToken ( const char *  value)
inline

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Definition at line 93 of file ListPredictorsRequest.h.


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