AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::DataPipeline::Model::QueryObjectsRequest Class Reference

#include <QueryObjectsRequest.h>

+ Inheritance diagram for Aws::DataPipeline::Model::QueryObjectsRequest:

Public Member Functions

 QueryObjectsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetPipelineId () const
 
bool PipelineIdHasBeenSet () const
 
void SetPipelineId (const Aws::String &value)
 
void SetPipelineId (Aws::String &&value)
 
void SetPipelineId (const char *value)
 
QueryObjectsRequestWithPipelineId (const Aws::String &value)
 
QueryObjectsRequestWithPipelineId (Aws::String &&value)
 
QueryObjectsRequestWithPipelineId (const char *value)
 
const QueryGetQuery () const
 
bool QueryHasBeenSet () const
 
void SetQuery (const Query &value)
 
void SetQuery (Query &&value)
 
QueryObjectsRequestWithQuery (const Query &value)
 
QueryObjectsRequestWithQuery (Query &&value)
 
const Aws::StringGetSphere () const
 
bool SphereHasBeenSet () const
 
void SetSphere (const Aws::String &value)
 
void SetSphere (Aws::String &&value)
 
void SetSphere (const char *value)
 
QueryObjectsRequestWithSphere (const Aws::String &value)
 
QueryObjectsRequestWithSphere (Aws::String &&value)
 
QueryObjectsRequestWithSphere (const char *value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
QueryObjectsRequestWithMarker (const Aws::String &value)
 
QueryObjectsRequestWithMarker (Aws::String &&value)
 
QueryObjectsRequestWithMarker (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
QueryObjectsRequestWithLimit (int value)
 
- Public Member Functions inherited from Aws::DataPipeline::DataPipelineRequest
virtual ~DataPipelineRequest ()
 
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

Contains the parameters for QueryObjects.

See Also:

AWS API Reference

Definition at line 25 of file QueryObjectsRequest.h.

Constructor & Destructor Documentation

◆ QueryObjectsRequest()

Aws::DataPipeline::Model::QueryObjectsRequest::QueryObjectsRequest ( )

Member Function Documentation

◆ GetLimit()

int Aws::DataPipeline::Model::QueryObjectsRequest::GetLimit ( ) const
inline

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Definition at line 257 of file QueryObjectsRequest.h.

◆ GetMarker()

const Aws::String& Aws::DataPipeline::Model::QueryObjectsRequest::GetMarker ( ) const
inline

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 194 of file QueryObjectsRequest.h.

◆ GetPipelineId()

const Aws::String& Aws::DataPipeline::Model::QueryObjectsRequest::GetPipelineId ( ) const
inline

The ID of the pipeline.

Definition at line 44 of file QueryObjectsRequest.h.

◆ GetQuery()

const Query& Aws::DataPipeline::Model::QueryObjectsRequest::GetQuery ( ) const
inline

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Definition at line 88 of file QueryObjectsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DataPipeline::Model::QueryObjectsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::DataPipeline::Model::QueryObjectsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file QueryObjectsRequest.h.

◆ GetSphere()

const Aws::String& Aws::DataPipeline::Model::QueryObjectsRequest::GetSphere ( ) const
inline

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Definition at line 136 of file QueryObjectsRequest.h.

◆ LimitHasBeenSet()

bool Aws::DataPipeline::Model::QueryObjectsRequest::LimitHasBeenSet ( ) const
inline

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Definition at line 263 of file QueryObjectsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::DataPipeline::Model::QueryObjectsRequest::MarkerHasBeenSet ( ) const
inline

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 202 of file QueryObjectsRequest.h.

◆ PipelineIdHasBeenSet()

bool Aws::DataPipeline::Model::QueryObjectsRequest::PipelineIdHasBeenSet ( ) const
inline

The ID of the pipeline.

Definition at line 49 of file QueryObjectsRequest.h.

◆ QueryHasBeenSet()

bool Aws::DataPipeline::Model::QueryObjectsRequest::QueryHasBeenSet ( ) const
inline

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Definition at line 96 of file QueryObjectsRequest.h.

◆ SerializePayload()

Aws::String Aws::DataPipeline::Model::QueryObjectsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLimit()

void Aws::DataPipeline::Model::QueryObjectsRequest::SetLimit ( int  value)
inline

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Definition at line 269 of file QueryObjectsRequest.h.

◆ SetMarker() [1/3]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetMarker ( const Aws::String value)
inline

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 210 of file QueryObjectsRequest.h.

◆ SetMarker() [2/3]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetMarker ( Aws::String &&  value)
inline

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 218 of file QueryObjectsRequest.h.

◆ SetMarker() [3/3]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetMarker ( const char *  value)
inline

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 226 of file QueryObjectsRequest.h.

◆ SetPipelineId() [1/3]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetPipelineId ( const Aws::String value)
inline

The ID of the pipeline.

Definition at line 54 of file QueryObjectsRequest.h.

◆ SetPipelineId() [2/3]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetPipelineId ( Aws::String &&  value)
inline

The ID of the pipeline.

Definition at line 59 of file QueryObjectsRequest.h.

◆ SetPipelineId() [3/3]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetPipelineId ( const char *  value)
inline

The ID of the pipeline.

Definition at line 64 of file QueryObjectsRequest.h.

◆ SetQuery() [1/2]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetQuery ( const Query value)
inline

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Definition at line 104 of file QueryObjectsRequest.h.

◆ SetQuery() [2/2]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetQuery ( Query &&  value)
inline

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Definition at line 112 of file QueryObjectsRequest.h.

◆ SetSphere() [1/3]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetSphere ( const Aws::String value)
inline

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Definition at line 150 of file QueryObjectsRequest.h.

◆ SetSphere() [2/3]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetSphere ( Aws::String &&  value)
inline

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Definition at line 157 of file QueryObjectsRequest.h.

◆ SetSphere() [3/3]

void Aws::DataPipeline::Model::QueryObjectsRequest::SetSphere ( const char *  value)
inline

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Definition at line 164 of file QueryObjectsRequest.h.

◆ SphereHasBeenSet()

bool Aws::DataPipeline::Model::QueryObjectsRequest::SphereHasBeenSet ( ) const
inline

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Definition at line 143 of file QueryObjectsRequest.h.

◆ WithLimit()

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithLimit ( int  value)
inline

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Definition at line 275 of file QueryObjectsRequest.h.

◆ WithMarker() [1/3]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithMarker ( const Aws::String value)
inline

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 234 of file QueryObjectsRequest.h.

◆ WithMarker() [2/3]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithMarker ( Aws::String &&  value)
inline

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 242 of file QueryObjectsRequest.h.

◆ WithMarker() [3/3]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithMarker ( const char *  value)
inline

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 250 of file QueryObjectsRequest.h.

◆ WithPipelineId() [1/3]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithPipelineId ( const Aws::String value)
inline

The ID of the pipeline.

Definition at line 69 of file QueryObjectsRequest.h.

◆ WithPipelineId() [2/3]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithPipelineId ( Aws::String &&  value)
inline

The ID of the pipeline.

Definition at line 74 of file QueryObjectsRequest.h.

◆ WithPipelineId() [3/3]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithPipelineId ( const char *  value)
inline

The ID of the pipeline.

Definition at line 79 of file QueryObjectsRequest.h.

◆ WithQuery() [1/2]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithQuery ( const Query value)
inline

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Definition at line 120 of file QueryObjectsRequest.h.

◆ WithQuery() [2/2]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithQuery ( Query &&  value)
inline

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Definition at line 128 of file QueryObjectsRequest.h.

◆ WithSphere() [1/3]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithSphere ( const Aws::String value)
inline

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Definition at line 171 of file QueryObjectsRequest.h.

◆ WithSphere() [2/3]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithSphere ( Aws::String &&  value)
inline

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Definition at line 178 of file QueryObjectsRequest.h.

◆ WithSphere() [3/3]

QueryObjectsRequest& Aws::DataPipeline::Model::QueryObjectsRequest::WithSphere ( const char *  value)
inline

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Definition at line 185 of file QueryObjectsRequest.h.


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