AWS SDK for C++  1.9.2
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::RDS::Model::DescribeExportTasksRequest Class Reference

#include <DescribeExportTasksRequest.h>

+ Inheritance diagram for Aws::RDS::Model::DescribeExportTasksRequest:

Public Member Functions

 DescribeExportTasksRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetExportTaskIdentifier () const
 
bool ExportTaskIdentifierHasBeenSet () const
 
void SetExportTaskIdentifier (const Aws::String &value)
 
void SetExportTaskIdentifier (Aws::String &&value)
 
void SetExportTaskIdentifier (const char *value)
 
DescribeExportTasksRequestWithExportTaskIdentifier (const Aws::String &value)
 
DescribeExportTasksRequestWithExportTaskIdentifier (Aws::String &&value)
 
DescribeExportTasksRequestWithExportTaskIdentifier (const char *value)
 
const Aws::StringGetSourceArn () const
 
bool SourceArnHasBeenSet () const
 
void SetSourceArn (const Aws::String &value)
 
void SetSourceArn (Aws::String &&value)
 
void SetSourceArn (const char *value)
 
DescribeExportTasksRequestWithSourceArn (const Aws::String &value)
 
DescribeExportTasksRequestWithSourceArn (Aws::String &&value)
 
DescribeExportTasksRequestWithSourceArn (const char *value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeExportTasksRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeExportTasksRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeExportTasksRequestAddFilters (const Filter &value)
 
DescribeExportTasksRequestAddFilters (Filter &&value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeExportTasksRequestWithMarker (const Aws::String &value)
 
DescribeExportTasksRequestWithMarker (Aws::String &&value)
 
DescribeExportTasksRequestWithMarker (const char *value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeExportTasksRequestWithMaxRecords (int value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 23 of file DescribeExportTasksRequest.h.

Constructor & Destructor Documentation

◆ DescribeExportTasksRequest()

Aws::RDS::Model::DescribeExportTasksRequest::DescribeExportTasksRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::AddFilters ( const Filter value)
inline

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.

  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.

  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

  • status - The status of the export task. Must be lowercase, for example, complete.

Definition at line 219 of file DescribeExportTasksRequest.h.

◆ AddFilters() [2/2]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::AddFilters ( Filter &&  value)
inline

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.

  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.

  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

  • status - The status of the export task. Must be lowercase, for example, complete.

Definition at line 233 of file DescribeExportTasksRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::DescribeExportTasksRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ ExportTaskIdentifierHasBeenSet()

bool Aws::RDS::Model::DescribeExportTasksRequest::ExportTaskIdentifierHasBeenSet ( ) const
inline

The identifier of the snapshot export task to be described.

Definition at line 49 of file DescribeExportTasksRequest.h.

◆ FiltersHasBeenSet()

bool Aws::RDS::Model::DescribeExportTasksRequest::FiltersHasBeenSet ( ) const
inline

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.

  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.

  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

  • status - The status of the export task. Must be lowercase, for example, complete.

Definition at line 149 of file DescribeExportTasksRequest.h.

◆ GetExportTaskIdentifier()

const Aws::String& Aws::RDS::Model::DescribeExportTasksRequest::GetExportTaskIdentifier ( ) const
inline

The identifier of the snapshot export task to be described.

Definition at line 44 of file DescribeExportTasksRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::RDS::Model::DescribeExportTasksRequest::GetFilters ( ) const
inline

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.

  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.

  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

  • status - The status of the export task. Must be lowercase, for example, complete.

Definition at line 135 of file DescribeExportTasksRequest.h.

◆ GetMarker()

const Aws::String& Aws::RDS::Model::DescribeExportTasksRequest::GetMarker ( ) const
inline

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Definition at line 242 of file DescribeExportTasksRequest.h.

◆ GetMaxRecords()

int Aws::RDS::Model::DescribeExportTasksRequest::GetMaxRecords ( ) const
inline

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 308 of file DescribeExportTasksRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RDS::Model::DescribeExportTasksRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeExportTasksRequest.h.

◆ GetSourceArn()

const Aws::String& Aws::RDS::Model::DescribeExportTasksRequest::GetSourceArn ( ) const
inline

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Definition at line 85 of file DescribeExportTasksRequest.h.

◆ MarkerHasBeenSet()

bool Aws::RDS::Model::DescribeExportTasksRequest::MarkerHasBeenSet ( ) const
inline

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Definition at line 250 of file DescribeExportTasksRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::RDS::Model::DescribeExportTasksRequest::MaxRecordsHasBeenSet ( ) const
inline

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 317 of file DescribeExportTasksRequest.h.

◆ SerializePayload()

Aws::String Aws::RDS::Model::DescribeExportTasksRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExportTaskIdentifier() [1/3]

void Aws::RDS::Model::DescribeExportTasksRequest::SetExportTaskIdentifier ( Aws::String &&  value)
inline

The identifier of the snapshot export task to be described.

Definition at line 59 of file DescribeExportTasksRequest.h.

◆ SetExportTaskIdentifier() [2/3]

void Aws::RDS::Model::DescribeExportTasksRequest::SetExportTaskIdentifier ( const Aws::String value)
inline

The identifier of the snapshot export task to be described.

Definition at line 54 of file DescribeExportTasksRequest.h.

◆ SetExportTaskIdentifier() [3/3]

void Aws::RDS::Model::DescribeExportTasksRequest::SetExportTaskIdentifier ( const char *  value)
inline

The identifier of the snapshot export task to be described.

Definition at line 64 of file DescribeExportTasksRequest.h.

◆ SetFilters() [1/2]

void Aws::RDS::Model::DescribeExportTasksRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.

  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.

  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

  • status - The status of the export task. Must be lowercase, for example, complete.

Definition at line 177 of file DescribeExportTasksRequest.h.

◆ SetFilters() [2/2]

void Aws::RDS::Model::DescribeExportTasksRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.

  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.

  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

  • status - The status of the export task. Must be lowercase, for example, complete.

Definition at line 163 of file DescribeExportTasksRequest.h.

◆ SetMarker() [1/3]

void Aws::RDS::Model::DescribeExportTasksRequest::SetMarker ( Aws::String &&  value)
inline

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Definition at line 266 of file DescribeExportTasksRequest.h.

◆ SetMarker() [2/3]

void Aws::RDS::Model::DescribeExportTasksRequest::SetMarker ( const Aws::String value)
inline

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Definition at line 258 of file DescribeExportTasksRequest.h.

◆ SetMarker() [3/3]

void Aws::RDS::Model::DescribeExportTasksRequest::SetMarker ( const char *  value)
inline

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Definition at line 274 of file DescribeExportTasksRequest.h.

◆ SetMaxRecords()

void Aws::RDS::Model::DescribeExportTasksRequest::SetMaxRecords ( int  value)
inline

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 326 of file DescribeExportTasksRequest.h.

◆ SetSourceArn() [1/3]

void Aws::RDS::Model::DescribeExportTasksRequest::SetSourceArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Definition at line 100 of file DescribeExportTasksRequest.h.

◆ SetSourceArn() [2/3]

void Aws::RDS::Model::DescribeExportTasksRequest::SetSourceArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Definition at line 95 of file DescribeExportTasksRequest.h.

◆ SetSourceArn() [3/3]

void Aws::RDS::Model::DescribeExportTasksRequest::SetSourceArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Definition at line 105 of file DescribeExportTasksRequest.h.

◆ SourceArnHasBeenSet()

bool Aws::RDS::Model::DescribeExportTasksRequest::SourceArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Definition at line 90 of file DescribeExportTasksRequest.h.

◆ WithExportTaskIdentifier() [1/3]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithExportTaskIdentifier ( Aws::String &&  value)
inline

The identifier of the snapshot export task to be described.

Definition at line 74 of file DescribeExportTasksRequest.h.

◆ WithExportTaskIdentifier() [2/3]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithExportTaskIdentifier ( const Aws::String value)
inline

The identifier of the snapshot export task to be described.

Definition at line 69 of file DescribeExportTasksRequest.h.

◆ WithExportTaskIdentifier() [3/3]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithExportTaskIdentifier ( const char *  value)
inline

The identifier of the snapshot export task to be described.

Definition at line 79 of file DescribeExportTasksRequest.h.

◆ WithFilters() [1/2]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.

  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.

  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

  • status - The status of the export task. Must be lowercase, for example, complete.

Definition at line 205 of file DescribeExportTasksRequest.h.

◆ WithFilters() [2/2]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.

  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.

  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3

  • status - The status of the export task. Must be lowercase, for example, complete.

Definition at line 191 of file DescribeExportTasksRequest.h.

◆ WithMarker() [1/3]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithMarker ( Aws::String &&  value)
inline

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Definition at line 290 of file DescribeExportTasksRequest.h.

◆ WithMarker() [2/3]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithMarker ( const Aws::String value)
inline

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Definition at line 282 of file DescribeExportTasksRequest.h.

◆ WithMarker() [3/3]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithMarker ( const char *  value)
inline

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Definition at line 298 of file DescribeExportTasksRequest.h.

◆ WithMaxRecords()

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithMaxRecords ( int  value)
inline

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 335 of file DescribeExportTasksRequest.h.

◆ WithSourceArn() [1/3]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithSourceArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Definition at line 115 of file DescribeExportTasksRequest.h.

◆ WithSourceArn() [2/3]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithSourceArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Definition at line 110 of file DescribeExportTasksRequest.h.

◆ WithSourceArn() [3/3]

DescribeExportTasksRequest& Aws::RDS::Model::DescribeExportTasksRequest::WithSourceArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Definition at line 120 of file DescribeExportTasksRequest.h.


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