Interface DescribeExportTasksRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeExportTasksRequest.Builder,DescribeExportTasksRequest>, RdsRequest.Builder, SdkBuilder<DescribeExportTasksRequest.Builder,DescribeExportTasksRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeExportTasksRequest
public static interface DescribeExportTasksRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<DescribeExportTasksRequest.Builder,DescribeExportTasksRequest>

  • Method Details

    • exportTaskIdentifier

      DescribeExportTasksRequest.Builder exportTaskIdentifier(String exportTaskIdentifier)

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

      Parameters:
      exportTaskIdentifier - The identifier of the snapshot or cluster export task to be described.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceArn

      DescribeExportTasksRequest.Builder sourceArn(String sourceArn)

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

      Parameters:
      sourceArn - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeExportTasksRequest.Builder filters(Collection<Filter> 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeExportTasksRequest.Builder filters(Filter... 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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeExportTasksRequest.Builder filters(Consumer<Filter.Builder>... 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

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • marker

      DescribeExportTasksRequest.Builder marker(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxRecords

      DescribeExportTasksRequest.Builder maxRecords(Integer 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceType

      DescribeExportTasksRequest.Builder sourceType(String sourceType)

      The type of source for the export.

      Parameters:
      sourceType - The type of source for the export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceType

      DescribeExportTasksRequest.Builder sourceType(ExportSourceType sourceType)

      The type of source for the export.

      Parameters:
      sourceType - The type of source for the export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      DescribeExportTasksRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeExportTasksRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.