AWS SDK for C++  1.8.60
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::ListJobsRequest Class Reference

#include <ListJobsRequest.h>

+ Inheritance diagram for Aws::IoT::Model::ListJobsRequest:

Public Member Functions

 ListJobsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const JobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobStatus &value)
 
void SetStatus (JobStatus &&value)
 
ListJobsRequestWithStatus (const JobStatus &value)
 
ListJobsRequestWithStatus (JobStatus &&value)
 
const TargetSelectionGetTargetSelection () const
 
bool TargetSelectionHasBeenSet () const
 
void SetTargetSelection (const TargetSelection &value)
 
void SetTargetSelection (TargetSelection &&value)
 
ListJobsRequestWithTargetSelection (const TargetSelection &value)
 
ListJobsRequestWithTargetSelection (TargetSelection &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListJobsRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListJobsRequestWithNextToken (const Aws::String &value)
 
ListJobsRequestWithNextToken (Aws::String &&value)
 
ListJobsRequestWithNextToken (const char *value)
 
const Aws::StringGetThingGroupName () const
 
bool ThingGroupNameHasBeenSet () const
 
void SetThingGroupName (const Aws::String &value)
 
void SetThingGroupName (Aws::String &&value)
 
void SetThingGroupName (const char *value)
 
ListJobsRequestWithThingGroupName (const Aws::String &value)
 
ListJobsRequestWithThingGroupName (Aws::String &&value)
 
ListJobsRequestWithThingGroupName (const char *value)
 
const Aws::StringGetThingGroupId () const
 
bool ThingGroupIdHasBeenSet () const
 
void SetThingGroupId (const Aws::String &value)
 
void SetThingGroupId (Aws::String &&value)
 
void SetThingGroupId (const char *value)
 
ListJobsRequestWithThingGroupId (const Aws::String &value)
 
ListJobsRequestWithThingGroupId (Aws::String &&value)
 
ListJobsRequestWithThingGroupId (const char *value)
 
- Public Member Functions inherited from Aws::IoT::IoTRequest
virtual ~IoTRequest ()
 
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 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::IoT::IoTRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file ListJobsRequest.h.

Constructor & Destructor Documentation

◆ ListJobsRequest()

Aws::IoT::Model::ListJobsRequest::ListJobsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::IoT::Model::ListJobsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetMaxResults()

int Aws::IoT::Model::ListJobsRequest::GetMaxResults ( ) const
inline

The maximum number of results to return per request.

Definition at line 144 of file ListJobsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::IoT::Model::ListJobsRequest::GetNextToken ( ) const
inline

The token to retrieve the next set of results.

Definition at line 165 of file ListJobsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoT::Model::ListJobsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file ListJobsRequest.h.

◆ GetStatus()

const JobStatus& Aws::IoT::Model::ListJobsRequest::GetStatus ( ) const
inline

An optional filter that lets you search for jobs that have the specified status.

Definition at line 47 of file ListJobsRequest.h.

◆ GetTargetSelection()

const TargetSelection& Aws::IoT::Model::ListJobsRequest::GetTargetSelection ( ) const
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 88 of file ListJobsRequest.h.

◆ GetThingGroupId()

const Aws::String& Aws::IoT::Model::ListJobsRequest::GetThingGroupId ( ) const
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 247 of file ListJobsRequest.h.

◆ GetThingGroupName()

const Aws::String& Aws::IoT::Model::ListJobsRequest::GetThingGroupName ( ) const
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 206 of file ListJobsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::IoT::Model::ListJobsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to return per request.

Definition at line 149 of file ListJobsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::IoT::Model::ListJobsRequest::NextTokenHasBeenSet ( ) const
inline

The token to retrieve the next set of results.

Definition at line 170 of file ListJobsRequest.h.

◆ SerializePayload()

Aws::String Aws::IoT::Model::ListJobsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::IoT::Model::ListJobsRequest::SetMaxResults ( int  value)
inline

The maximum number of results to return per request.

Definition at line 154 of file ListJobsRequest.h.

◆ SetNextToken() [1/3]

void Aws::IoT::Model::ListJobsRequest::SetNextToken ( const Aws::String value)
inline

The token to retrieve the next set of results.

Definition at line 175 of file ListJobsRequest.h.

◆ SetNextToken() [2/3]

void Aws::IoT::Model::ListJobsRequest::SetNextToken ( Aws::String &&  value)
inline

The token to retrieve the next set of results.

Definition at line 180 of file ListJobsRequest.h.

◆ SetNextToken() [3/3]

void Aws::IoT::Model::ListJobsRequest::SetNextToken ( const char *  value)
inline

The token to retrieve the next set of results.

Definition at line 185 of file ListJobsRequest.h.

◆ SetStatus() [1/2]

void Aws::IoT::Model::ListJobsRequest::SetStatus ( const JobStatus value)
inline

An optional filter that lets you search for jobs that have the specified status.

Definition at line 59 of file ListJobsRequest.h.

◆ SetStatus() [2/2]

void Aws::IoT::Model::ListJobsRequest::SetStatus ( JobStatus &&  value)
inline

An optional filter that lets you search for jobs that have the specified status.

Definition at line 65 of file ListJobsRequest.h.

◆ SetTargetSelection() [1/2]

void Aws::IoT::Model::ListJobsRequest::SetTargetSelection ( const TargetSelection value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 108 of file ListJobsRequest.h.

◆ SetTargetSelection() [2/2]

void Aws::IoT::Model::ListJobsRequest::SetTargetSelection ( TargetSelection &&  value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 118 of file ListJobsRequest.h.

◆ SetThingGroupId() [1/3]

void Aws::IoT::Model::ListJobsRequest::SetThingGroupId ( const Aws::String value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 257 of file ListJobsRequest.h.

◆ SetThingGroupId() [2/3]

void Aws::IoT::Model::ListJobsRequest::SetThingGroupId ( Aws::String &&  value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 262 of file ListJobsRequest.h.

◆ SetThingGroupId() [3/3]

void Aws::IoT::Model::ListJobsRequest::SetThingGroupId ( const char *  value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 267 of file ListJobsRequest.h.

◆ SetThingGroupName() [1/3]

void Aws::IoT::Model::ListJobsRequest::SetThingGroupName ( const Aws::String value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 216 of file ListJobsRequest.h.

◆ SetThingGroupName() [2/3]

void Aws::IoT::Model::ListJobsRequest::SetThingGroupName ( Aws::String &&  value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 221 of file ListJobsRequest.h.

◆ SetThingGroupName() [3/3]

void Aws::IoT::Model::ListJobsRequest::SetThingGroupName ( const char *  value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 226 of file ListJobsRequest.h.

◆ StatusHasBeenSet()

bool Aws::IoT::Model::ListJobsRequest::StatusHasBeenSet ( ) const
inline

An optional filter that lets you search for jobs that have the specified status.

Definition at line 53 of file ListJobsRequest.h.

◆ TargetSelectionHasBeenSet()

bool Aws::IoT::Model::ListJobsRequest::TargetSelectionHasBeenSet ( ) const
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 98 of file ListJobsRequest.h.

◆ ThingGroupIdHasBeenSet()

bool Aws::IoT::Model::ListJobsRequest::ThingGroupIdHasBeenSet ( ) const
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 252 of file ListJobsRequest.h.

◆ ThingGroupNameHasBeenSet()

bool Aws::IoT::Model::ListJobsRequest::ThingGroupNameHasBeenSet ( ) const
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 211 of file ListJobsRequest.h.

◆ WithMaxResults()

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithMaxResults ( int  value)
inline

The maximum number of results to return per request.

Definition at line 159 of file ListJobsRequest.h.

◆ WithNextToken() [1/3]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithNextToken ( const Aws::String value)
inline

The token to retrieve the next set of results.

Definition at line 190 of file ListJobsRequest.h.

◆ WithNextToken() [2/3]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithNextToken ( Aws::String &&  value)
inline

The token to retrieve the next set of results.

Definition at line 195 of file ListJobsRequest.h.

◆ WithNextToken() [3/3]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithNextToken ( const char *  value)
inline

The token to retrieve the next set of results.

Definition at line 200 of file ListJobsRequest.h.

◆ WithStatus() [1/2]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithStatus ( const JobStatus value)
inline

An optional filter that lets you search for jobs that have the specified status.

Definition at line 71 of file ListJobsRequest.h.

◆ WithStatus() [2/2]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithStatus ( JobStatus &&  value)
inline

An optional filter that lets you search for jobs that have the specified status.

Definition at line 77 of file ListJobsRequest.h.

◆ WithTargetSelection() [1/2]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithTargetSelection ( const TargetSelection value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 128 of file ListJobsRequest.h.

◆ WithTargetSelection() [2/2]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithTargetSelection ( TargetSelection &&  value)
inline

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Definition at line 138 of file ListJobsRequest.h.

◆ WithThingGroupId() [1/3]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithThingGroupId ( const Aws::String value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 272 of file ListJobsRequest.h.

◆ WithThingGroupId() [2/3]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithThingGroupId ( Aws::String &&  value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 277 of file ListJobsRequest.h.

◆ WithThingGroupId() [3/3]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithThingGroupId ( const char *  value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 282 of file ListJobsRequest.h.

◆ WithThingGroupName() [1/3]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithThingGroupName ( const Aws::String value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 231 of file ListJobsRequest.h.

◆ WithThingGroupName() [2/3]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithThingGroupName ( Aws::String &&  value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 236 of file ListJobsRequest.h.

◆ WithThingGroupName() [3/3]

ListJobsRequest& Aws::IoT::Model::ListJobsRequest::WithThingGroupName ( const char *  value)
inline

A filter that limits the returned jobs to those for the specified group.

Definition at line 241 of file ListJobsRequest.h.


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