Interface DescribeExportTasksRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeExportTasksRequest.Builder,
,DescribeExportTasksRequest> RdsRequest.Builder
,SdkBuilder<DescribeExportTasksRequest.Builder,
,DescribeExportTasksRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeExportTasksRequest
-
Method Summary
Modifier and TypeMethodDescriptionexportTaskIdentifier
(String exportTaskIdentifier) The identifier of the snapshot or cluster export task to be described.filters
(Collection<Filter> filters) Filters specify one or more snapshot or cluster exports to describe.filters
(Consumer<Filter.Builder>... filters) Filters specify one or more snapshot or cluster exports to describe.Filters specify one or more snapshot or cluster exports to describe.An optional pagination token provided by a previousDescribeExportTasks
request.maxRecords
(Integer maxRecords) The maximum number of records to include in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.sourceType
(String sourceType) The type of source for the export.sourceType
(ExportSourceType sourceType) The type of source for the export.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
-
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 theMaxRecords
parameter.- Parameters:
marker
- An optional pagination token provided by a previousDescribeExportTasks
request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by theMaxRecords
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 laterDescribeExportTasks
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
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-