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

#include <DescribeObjectsRequest.h>

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

Public Member Functions

 DescribeObjectsRequest ()
 
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)
 
DescribeObjectsRequestWithPipelineId (const Aws::String &value)
 
DescribeObjectsRequestWithPipelineId (Aws::String &&value)
 
DescribeObjectsRequestWithPipelineId (const char *value)
 
const Aws::Vector< Aws::String > & GetObjectIds () const
 
bool ObjectIdsHasBeenSet () const
 
void SetObjectIds (const Aws::Vector< Aws::String > &value)
 
void SetObjectIds (Aws::Vector< Aws::String > &&value)
 
DescribeObjectsRequestWithObjectIds (const Aws::Vector< Aws::String > &value)
 
DescribeObjectsRequestWithObjectIds (Aws::Vector< Aws::String > &&value)
 
DescribeObjectsRequestAddObjectIds (const Aws::String &value)
 
DescribeObjectsRequestAddObjectIds (Aws::String &&value)
 
DescribeObjectsRequestAddObjectIds (const char *value)
 
bool GetEvaluateExpressions () const
 
bool EvaluateExpressionsHasBeenSet () const
 
void SetEvaluateExpressions (bool value)
 
DescribeObjectsRequestWithEvaluateExpressions (bool value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeObjectsRequestWithMarker (const Aws::String &value)
 
DescribeObjectsRequestWithMarker (Aws::String &&value)
 
DescribeObjectsRequestWithMarker (const char *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 DescribeObjects.

See Also:

AWS API Reference

Definition at line 25 of file DescribeObjectsRequest.h.

Constructor & Destructor Documentation

◆ DescribeObjectsRequest()

Aws::DataPipeline::Model::DescribeObjectsRequest::DescribeObjectsRequest ( )

Member Function Documentation

◆ AddObjectIds() [1/3]

DescribeObjectsRequest& Aws::DataPipeline::Model::DescribeObjectsRequest::AddObjectIds ( const Aws::String value)
inline

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Definition at line 129 of file DescribeObjectsRequest.h.

◆ AddObjectIds() [2/3]

DescribeObjectsRequest& Aws::DataPipeline::Model::DescribeObjectsRequest::AddObjectIds ( Aws::String &&  value)
inline

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Definition at line 136 of file DescribeObjectsRequest.h.

◆ AddObjectIds() [3/3]

DescribeObjectsRequest& Aws::DataPipeline::Model::DescribeObjectsRequest::AddObjectIds ( const char *  value)
inline

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Definition at line 143 of file DescribeObjectsRequest.h.

◆ EvaluateExpressionsHasBeenSet()

bool Aws::DataPipeline::Model::DescribeObjectsRequest::EvaluateExpressionsHasBeenSet ( ) const
inline

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Definition at line 156 of file DescribeObjectsRequest.h.

◆ GetEvaluateExpressions()

bool Aws::DataPipeline::Model::DescribeObjectsRequest::GetEvaluateExpressions ( ) const
inline

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Definition at line 150 of file DescribeObjectsRequest.h.

◆ GetMarker()

const Aws::String& Aws::DataPipeline::Model::DescribeObjectsRequest::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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 177 of file DescribeObjectsRequest.h.

◆ GetObjectIds()

const Aws::Vector<Aws::String>& Aws::DataPipeline::Model::DescribeObjectsRequest::GetObjectIds ( ) const
inline

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Definition at line 87 of file DescribeObjectsRequest.h.

◆ GetPipelineId()

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

The ID of the pipeline that contains the object definitions.

Definition at line 44 of file DescribeObjectsRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeObjectsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::DataPipeline::Model::DescribeObjectsRequest::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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 185 of file DescribeObjectsRequest.h.

◆ ObjectIdsHasBeenSet()

bool Aws::DataPipeline::Model::DescribeObjectsRequest::ObjectIdsHasBeenSet ( ) const
inline

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Definition at line 94 of file DescribeObjectsRequest.h.

◆ PipelineIdHasBeenSet()

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

The ID of the pipeline that contains the object definitions.

Definition at line 49 of file DescribeObjectsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEvaluateExpressions()

void Aws::DataPipeline::Model::DescribeObjectsRequest::SetEvaluateExpressions ( bool  value)
inline

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Definition at line 162 of file DescribeObjectsRequest.h.

◆ SetMarker() [1/3]

void Aws::DataPipeline::Model::DescribeObjectsRequest::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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 193 of file DescribeObjectsRequest.h.

◆ SetMarker() [2/3]

void Aws::DataPipeline::Model::DescribeObjectsRequest::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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 201 of file DescribeObjectsRequest.h.

◆ SetMarker() [3/3]

void Aws::DataPipeline::Model::DescribeObjectsRequest::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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 209 of file DescribeObjectsRequest.h.

◆ SetObjectIds() [1/2]

void Aws::DataPipeline::Model::DescribeObjectsRequest::SetObjectIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Definition at line 101 of file DescribeObjectsRequest.h.

◆ SetObjectIds() [2/2]

void Aws::DataPipeline::Model::DescribeObjectsRequest::SetObjectIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Definition at line 108 of file DescribeObjectsRequest.h.

◆ SetPipelineId() [1/3]

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

The ID of the pipeline that contains the object definitions.

Definition at line 54 of file DescribeObjectsRequest.h.

◆ SetPipelineId() [2/3]

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

The ID of the pipeline that contains the object definitions.

Definition at line 59 of file DescribeObjectsRequest.h.

◆ SetPipelineId() [3/3]

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

The ID of the pipeline that contains the object definitions.

Definition at line 64 of file DescribeObjectsRequest.h.

◆ WithEvaluateExpressions()

DescribeObjectsRequest& Aws::DataPipeline::Model::DescribeObjectsRequest::WithEvaluateExpressions ( bool  value)
inline

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Definition at line 168 of file DescribeObjectsRequest.h.

◆ WithMarker() [1/3]

DescribeObjectsRequest& Aws::DataPipeline::Model::DescribeObjectsRequest::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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 217 of file DescribeObjectsRequest.h.

◆ WithMarker() [2/3]

DescribeObjectsRequest& Aws::DataPipeline::Model::DescribeObjectsRequest::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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 225 of file DescribeObjectsRequest.h.

◆ WithMarker() [3/3]

DescribeObjectsRequest& Aws::DataPipeline::Model::DescribeObjectsRequest::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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

Definition at line 233 of file DescribeObjectsRequest.h.

◆ WithObjectIds() [1/2]

DescribeObjectsRequest& Aws::DataPipeline::Model::DescribeObjectsRequest::WithObjectIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Definition at line 115 of file DescribeObjectsRequest.h.

◆ WithObjectIds() [2/2]

DescribeObjectsRequest& Aws::DataPipeline::Model::DescribeObjectsRequest::WithObjectIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

Definition at line 122 of file DescribeObjectsRequest.h.

◆ WithPipelineId() [1/3]

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

The ID of the pipeline that contains the object definitions.

Definition at line 69 of file DescribeObjectsRequest.h.

◆ WithPipelineId() [2/3]

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

The ID of the pipeline that contains the object definitions.

Definition at line 74 of file DescribeObjectsRequest.h.

◆ WithPipelineId() [3/3]

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

The ID of the pipeline that contains the object definitions.

Definition at line 79 of file DescribeObjectsRequest.h.


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