/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace RDS { namespace Model { /** */ class DescribeExportTasksRequest : public RDSRequest { public: AWS_RDS_API DescribeExportTasksRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeExportTasks"; } AWS_RDS_API Aws::String SerializePayload() const override; protected: AWS_RDS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The identifier of the snapshot or cluster export task to be described.

*/ inline const Aws::String& GetExportTaskIdentifier() const{ return m_exportTaskIdentifier; } /** *

The identifier of the snapshot or cluster export task to be described.

*/ inline bool ExportTaskIdentifierHasBeenSet() const { return m_exportTaskIdentifierHasBeenSet; } /** *

The identifier of the snapshot or cluster export task to be described.

*/ inline void SetExportTaskIdentifier(const Aws::String& value) { m_exportTaskIdentifierHasBeenSet = true; m_exportTaskIdentifier = value; } /** *

The identifier of the snapshot or cluster export task to be described.

*/ inline void SetExportTaskIdentifier(Aws::String&& value) { m_exportTaskIdentifierHasBeenSet = true; m_exportTaskIdentifier = std::move(value); } /** *

The identifier of the snapshot or cluster export task to be described.

*/ inline void SetExportTaskIdentifier(const char* value) { m_exportTaskIdentifierHasBeenSet = true; m_exportTaskIdentifier.assign(value); } /** *

The identifier of the snapshot or cluster export task to be described.

*/ inline DescribeExportTasksRequest& WithExportTaskIdentifier(const Aws::String& value) { SetExportTaskIdentifier(value); return *this;} /** *

The identifier of the snapshot or cluster export task to be described.

*/ inline DescribeExportTasksRequest& WithExportTaskIdentifier(Aws::String&& value) { SetExportTaskIdentifier(std::move(value)); return *this;} /** *

The identifier of the snapshot or cluster export task to be described.

*/ inline DescribeExportTasksRequest& WithExportTaskIdentifier(const char* value) { SetExportTaskIdentifier(value); return *this;} /** *

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

*/ inline const Aws::String& GetSourceArn() const{ return m_sourceArn; } /** *

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

*/ inline bool SourceArnHasBeenSet() const { return m_sourceArnHasBeenSet; } /** *

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

*/ inline void SetSourceArn(const Aws::String& value) { m_sourceArnHasBeenSet = true; m_sourceArn = value; } /** *

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

*/ inline void SetSourceArn(Aws::String&& value) { m_sourceArnHasBeenSet = true; m_sourceArn = std::move(value); } /** *

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

*/ inline void SetSourceArn(const char* value) { m_sourceArnHasBeenSet = true; m_sourceArn.assign(value); } /** *

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

*/ inline DescribeExportTasksRequest& WithSourceArn(const Aws::String& value) { SetSourceArn(value); return *this;} /** *

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

*/ inline DescribeExportTasksRequest& WithSourceArn(Aws::String&& value) { SetSourceArn(std::move(value)); return *this;} /** *

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

*/ inline DescribeExportTasksRequest& WithSourceArn(const char* value) { SetSourceArn(value); return *this;} /** *

Filters specify one or more snapshot or cluster 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 or cluster export task.

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

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

  • * status - The status of the export task. Must be lowercase. Valid * statuses are the following:

    • canceled

    • *
    • canceling

    • complete

      *
    • failed

    • in_progress *

    • starting

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

Filters specify one or more snapshot or cluster 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 or cluster export task.

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

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

  • * status - The status of the export task. Must be lowercase. Valid * statuses are the following:

    • canceled

    • *
    • canceling

    • complete

      *
    • failed

    • in_progress *

    • starting

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

Filters specify one or more snapshot or cluster 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 or cluster export task.

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

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

  • * status - The status of the export task. Must be lowercase. Valid * statuses are the following:

    • canceled

    • *
    • canceling

    • complete

      *
    • failed

    • in_progress *

    • starting

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

Filters specify one or more snapshot or cluster 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 or cluster export task.

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

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

  • * status - The status of the export task. Must be lowercase. Valid * statuses are the following:

    • canceled

    • *
    • canceling

    • complete

      *
    • failed

    • in_progress *

    • starting

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

Filters specify one or more snapshot or cluster 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 or cluster export task.

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

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

  • * status - The status of the export task. Must be lowercase. Valid * statuses are the following:

    • canceled

    • *
    • canceling

    • complete

      *
    • failed

    • in_progress *

    • starting

*/ inline DescribeExportTasksRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

Filters specify one or more snapshot or cluster 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 or cluster export task.

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

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

  • * status - The status of the export task. Must be lowercase. Valid * statuses are the following:

    • canceled

    • *
    • canceling

    • complete

      *
    • failed

    • in_progress *

    • starting

*/ inline DescribeExportTasksRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

Filters specify one or more snapshot or cluster 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 or cluster export task.

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

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

  • * status - The status of the export task. Must be lowercase. Valid * statuses are the following:

    • canceled

    • *
    • canceling

    • complete

      *
    • failed

    • in_progress *

    • starting

*/ inline DescribeExportTasksRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

Filters specify one or more snapshot or cluster 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 or cluster export task.

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

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

  • * status - The status of the export task. Must be lowercase. Valid * statuses are the following:

    • canceled

    • *
    • canceling

    • complete

      *
    • failed

    • in_progress *

    • starting

*/ inline DescribeExportTasksRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

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.

*/ inline const Aws::String& GetMarker() const{ return m_marker; } /** *

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.

*/ inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } /** *

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.

*/ inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; } /** *

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.

*/ inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); } /** *

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.

*/ inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); } /** *

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.

*/ inline DescribeExportTasksRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;} /** *

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.

*/ inline DescribeExportTasksRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;} /** *

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.

*/ inline DescribeExportTasksRequest& WithMarker(const char* value) { SetMarker(value); return *this;} /** *

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.

*/ inline int GetMaxRecords() const{ return m_maxRecords; } /** *

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.

*/ inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; } /** *

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.

*/ inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; } /** *

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.

*/ inline DescribeExportTasksRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} /** *

The type of source for the export.

*/ inline const ExportSourceType& GetSourceType() const{ return m_sourceType; } /** *

The type of source for the export.

*/ inline bool SourceTypeHasBeenSet() const { return m_sourceTypeHasBeenSet; } /** *

The type of source for the export.

*/ inline void SetSourceType(const ExportSourceType& value) { m_sourceTypeHasBeenSet = true; m_sourceType = value; } /** *

The type of source for the export.

*/ inline void SetSourceType(ExportSourceType&& value) { m_sourceTypeHasBeenSet = true; m_sourceType = std::move(value); } /** *

The type of source for the export.

*/ inline DescribeExportTasksRequest& WithSourceType(const ExportSourceType& value) { SetSourceType(value); return *this;} /** *

The type of source for the export.

*/ inline DescribeExportTasksRequest& WithSourceType(ExportSourceType&& value) { SetSourceType(std::move(value)); return *this;} private: Aws::String m_exportTaskIdentifier; bool m_exportTaskIdentifierHasBeenSet = false; Aws::String m_sourceArn; bool m_sourceArnHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; int m_maxRecords; bool m_maxRecordsHasBeenSet = false; ExportSourceType m_sourceType; bool m_sourceTypeHasBeenSet = false; }; } // namespace Model } // namespace RDS } // namespace Aws