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

#include <ListForecastsRequest.h>

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

Public Member Functions

 ListForecastsRequest ()
 
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)
 
ListForecastsRequestWithNextToken (const Aws::String &value)
 
ListForecastsRequestWithNextToken (Aws::String &&value)
 
ListForecastsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListForecastsRequestWithMaxResults (int value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
ListForecastsRequestWithFilters (const Aws::Vector< Filter > &value)
 
ListForecastsRequestWithFilters (Aws::Vector< Filter > &&value)
 
ListForecastsRequestAddFilters (const Filter &value)
 
ListForecastsRequestAddFilters (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 ListForecastsRequest.h.

Constructor & Destructor Documentation

◆ ListForecastsRequest()

Aws::ForecastService::Model::ListForecastsRequest::ListForecastsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

ListForecastsRequest& Aws::ForecastService::Model::ListForecastsRequest::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 forecasts 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 forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

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

  • Value - The value to match.

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

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

Definition at line 248 of file ListForecastsRequest.h.

◆ AddFilters() [2/2]

ListForecastsRequest& Aws::ForecastService::Model::ListForecastsRequest::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 forecasts 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 forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

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

  • Value - The value to match.

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

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

Definition at line 267 of file ListForecastsRequest.h.

◆ FiltersHasBeenSet()

bool Aws::ForecastService::Model::ListForecastsRequest::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 forecasts 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 forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

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

  • Value - The value to match.

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

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

Definition at line 153 of file ListForecastsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::ForecastService::Model::ListForecastsRequest::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 forecasts 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 forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

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

  • Value - The value to match.

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

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

Definition at line 134 of file ListForecastsRequest.h.

◆ GetMaxResults()

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

The number of items to return in the response.

Definition at line 99 of file ListForecastsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::ForecastService::Model::ListForecastsRequest::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 ListForecastsRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListForecastsRequest.h.

◆ MaxResultsHasBeenSet()

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

The number of items to return in the response.

Definition at line 104 of file ListForecastsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::ForecastService::Model::ListForecastsRequest::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 ListForecastsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::ForecastService::Model::ListForecastsRequest::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 forecasts 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 forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

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

  • Value - The value to match.

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

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

Definition at line 191 of file ListForecastsRequest.h.

◆ SetFilters() [2/2]

void Aws::ForecastService::Model::ListForecastsRequest::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 forecasts 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 forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

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

  • Value - The value to match.

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

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

Definition at line 172 of file ListForecastsRequest.h.

◆ SetMaxResults()

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

The number of items to return in the response.

Definition at line 109 of file ListForecastsRequest.h.

◆ SetNextToken() [1/3]

void Aws::ForecastService::Model::ListForecastsRequest::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 ListForecastsRequest.h.

◆ SetNextToken() [2/3]

void Aws::ForecastService::Model::ListForecastsRequest::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 ListForecastsRequest.h.

◆ SetNextToken() [3/3]

void Aws::ForecastService::Model::ListForecastsRequest::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 ListForecastsRequest.h.

◆ WithFilters() [1/2]

ListForecastsRequest& Aws::ForecastService::Model::ListForecastsRequest::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 forecasts 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 forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

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

  • Value - The value to match.

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

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

Definition at line 229 of file ListForecastsRequest.h.

◆ WithFilters() [2/2]

ListForecastsRequest& Aws::ForecastService::Model::ListForecastsRequest::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 forecasts 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 forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

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

  • Value - The value to match.

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

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

Definition at line 210 of file ListForecastsRequest.h.

◆ WithMaxResults()

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

The number of items to return in the response.

Definition at line 114 of file ListForecastsRequest.h.

◆ WithNextToken() [1/3]

ListForecastsRequest& Aws::ForecastService::Model::ListForecastsRequest::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 ListForecastsRequest.h.

◆ WithNextToken() [2/3]

ListForecastsRequest& Aws::ForecastService::Model::ListForecastsRequest::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 ListForecastsRequest.h.

◆ WithNextToken() [3/3]

ListForecastsRequest& Aws::ForecastService::Model::ListForecastsRequest::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 ListForecastsRequest.h.


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