@Generated(value="software.amazon.awssdk:codegen") public interface DataPipelineAsyncClient extends SdkClient
builder() method.
AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data.
AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.
AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<ActivatePipelineResponse> |
activatePipeline(ActivatePipelineRequest activatePipelineRequest)
Validates the specified pipeline and starts processing pipeline tasks.
|
default CompletableFuture<ActivatePipelineResponse> |
activatePipeline(Consumer<ActivatePipelineRequest.Builder> activatePipelineRequest)
Validates the specified pipeline and starts processing pipeline tasks.
|
default CompletableFuture<AddTagsResponse> |
addTags(AddTagsRequest addTagsRequest)
Adds or modifies tags for the specified pipeline.
|
default CompletableFuture<AddTagsResponse> |
addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Adds or modifies tags for the specified pipeline.
|
static DataPipelineAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DataPipelineAsyncClient. |
static DataPipelineAsyncClient |
create()
Create a
DataPipelineAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreatePipelineResponse> |
createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates a new, empty pipeline.
|
default CompletableFuture<CreatePipelineResponse> |
createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a new, empty pipeline.
|
default CompletableFuture<DeactivatePipelineResponse> |
deactivatePipeline(Consumer<DeactivatePipelineRequest.Builder> deactivatePipelineRequest)
Deactivates the specified running pipeline.
|
default CompletableFuture<DeactivatePipelineResponse> |
deactivatePipeline(DeactivatePipelineRequest deactivatePipelineRequest)
Deactivates the specified running pipeline.
|
default CompletableFuture<DeletePipelineResponse> |
deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes a pipeline, its pipeline definition, and its run history.
|
default CompletableFuture<DeletePipelineResponse> |
deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes a pipeline, its pipeline definition, and its run history.
|
default CompletableFuture<DescribeObjectsResponse> |
describeObjects(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline.
|
default CompletableFuture<DescribeObjectsResponse> |
describeObjects(DescribeObjectsRequest describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline.
|
default DescribeObjectsPublisher |
describeObjectsPaginator(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline.
|
default DescribeObjectsPublisher |
describeObjectsPaginator(DescribeObjectsRequest describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline.
|
default CompletableFuture<DescribePipelinesResponse> |
describePipelines(Consumer<DescribePipelinesRequest.Builder> describePipelinesRequest)
Retrieves metadata about one or more pipelines.
|
default CompletableFuture<DescribePipelinesResponse> |
describePipelines(DescribePipelinesRequest describePipelinesRequest)
Retrieves metadata about one or more pipelines.
|
default CompletableFuture<EvaluateExpressionResponse> |
evaluateExpression(Consumer<EvaluateExpressionRequest.Builder> evaluateExpressionRequest)
Task runners call
EvaluateExpression to evaluate a string in the context of the specified object. |
default CompletableFuture<EvaluateExpressionResponse> |
evaluateExpression(EvaluateExpressionRequest evaluateExpressionRequest)
Task runners call
EvaluateExpression to evaluate a string in the context of the specified object. |
default CompletableFuture<GetPipelineDefinitionResponse> |
getPipelineDefinition(Consumer<GetPipelineDefinitionRequest.Builder> getPipelineDefinitionRequest)
Gets the definition of the specified pipeline.
|
default CompletableFuture<GetPipelineDefinitionResponse> |
getPipelineDefinition(GetPipelineDefinitionRequest getPipelineDefinitionRequest)
Gets the definition of the specified pipeline.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines()
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default CompletableFuture<ListPipelinesResponse> |
listPipelines(ListPipelinesRequest listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default ListPipelinesPublisher |
listPipelinesPaginator()
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default ListPipelinesPublisher |
listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default ListPipelinesPublisher |
listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
default CompletableFuture<PollForTaskResponse> |
pollForTask(Consumer<PollForTaskRequest.Builder> pollForTaskRequest)
Task runners call
PollForTask to receive a task to perform from AWS Data Pipeline. |
default CompletableFuture<PollForTaskResponse> |
pollForTask(PollForTaskRequest pollForTaskRequest)
Task runners call
PollForTask to receive a task to perform from AWS Data Pipeline. |
default CompletableFuture<PutPipelineDefinitionResponse> |
putPipelineDefinition(Consumer<PutPipelineDefinitionRequest.Builder> putPipelineDefinitionRequest)
Adds tasks, schedules, and preconditions to the specified pipeline.
|
default CompletableFuture<PutPipelineDefinitionResponse> |
putPipelineDefinition(PutPipelineDefinitionRequest putPipelineDefinitionRequest)
Adds tasks, schedules, and preconditions to the specified pipeline.
|
default CompletableFuture<QueryObjectsResponse> |
queryObjects(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
|
default CompletableFuture<QueryObjectsResponse> |
queryObjects(QueryObjectsRequest queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
|
default QueryObjectsPublisher |
queryObjectsPaginator(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
|
default QueryObjectsPublisher |
queryObjectsPaginator(QueryObjectsRequest queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
|
default CompletableFuture<RemoveTagsResponse> |
removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes existing tags from the specified pipeline.
|
default CompletableFuture<RemoveTagsResponse> |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes existing tags from the specified pipeline.
|
default CompletableFuture<ReportTaskProgressResponse> |
reportTaskProgress(Consumer<ReportTaskProgressRequest.Builder> reportTaskProgressRequest)
Task runners call
ReportTaskProgress when assigned a task to acknowledge that it has the task. |
default CompletableFuture<ReportTaskProgressResponse> |
reportTaskProgress(ReportTaskProgressRequest reportTaskProgressRequest)
Task runners call
ReportTaskProgress when assigned a task to acknowledge that it has the task. |
default CompletableFuture<ReportTaskRunnerHeartbeatResponse> |
reportTaskRunnerHeartbeat(Consumer<ReportTaskRunnerHeartbeatRequest.Builder> reportTaskRunnerHeartbeatRequest)
Task runners call
ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. |
default CompletableFuture<ReportTaskRunnerHeartbeatResponse> |
reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest)
Task runners call
ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. |
default CompletableFuture<SetStatusResponse> |
setStatus(Consumer<SetStatusRequest.Builder> setStatusRequest)
Requests that the status of the specified physical or logical pipeline objects be updated in the specified
pipeline.
|
default CompletableFuture<SetStatusResponse> |
setStatus(SetStatusRequest setStatusRequest)
Requests that the status of the specified physical or logical pipeline objects be updated in the specified
pipeline.
|
default CompletableFuture<SetTaskStatusResponse> |
setTaskStatus(Consumer<SetTaskStatusRequest.Builder> setTaskStatusRequest)
Task runners call
SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide
information about the final status. |
default CompletableFuture<SetTaskStatusResponse> |
setTaskStatus(SetTaskStatusRequest setTaskStatusRequest)
Task runners call
SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide
information about the final status. |
default CompletableFuture<ValidatePipelineDefinitionResponse> |
validatePipelineDefinition(Consumer<ValidatePipelineDefinitionRequest.Builder> validatePipelineDefinitionRequest)
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
|
default CompletableFuture<ValidatePipelineDefinitionResponse> |
validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest)
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
|
serviceNameclosestatic final String SERVICE_NAME
static DataPipelineAsyncClient create()
DataPipelineAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DataPipelineAsyncClientBuilder builder()
DataPipelineAsyncClient.default CompletableFuture<ActivatePipelineResponse> activatePipeline(ActivatePipelineRequest activatePipelineRequest)
Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.
If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.
To activate a finished pipeline, modify the end date for the pipeline and then activate it.
activatePipelineRequest - Contains the parameters for ActivatePipeline.default CompletableFuture<ActivatePipelineResponse> activatePipeline(Consumer<ActivatePipelineRequest.Builder> activatePipelineRequest)
Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.
If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.
To activate a finished pipeline, modify the end date for the pipeline and then activate it.
This is a convenience which creates an instance of the ActivatePipelineRequest.Builder avoiding the need
to create one manually via ActivatePipelineRequest.builder()
activatePipelineRequest - A Consumer that will call methods on ActivatePipelineInput.Builder to create a request.
Contains the parameters for ActivatePipeline.default CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest)
Adds or modifies tags for the specified pipeline.
addTagsRequest - Contains the parameters for AddTags.default CompletableFuture<AddTagsResponse> addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Adds or modifies tags for the specified pipeline.
This is a convenience which creates an instance of the AddTagsRequest.Builder avoiding the need to create
one manually via AddTagsRequest.builder()
addTagsRequest - A Consumer that will call methods on AddTagsInput.Builder to create a request. Contains
the parameters for AddTags.default CompletableFuture<CreatePipelineResponse> createPipeline(CreatePipelineRequest createPipelineRequest)
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
createPipelineRequest - Contains the parameters for CreatePipeline.default CompletableFuture<CreatePipelineResponse> createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest)
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
This is a convenience which creates an instance of the CreatePipelineRequest.Builder avoiding the need to
create one manually via CreatePipelineRequest.builder()
createPipelineRequest - A Consumer that will call methods on CreatePipelineInput.Builder to create a request.
Contains the parameters for CreatePipeline.default CompletableFuture<DeactivatePipelineResponse> deactivatePipeline(DeactivatePipelineRequest deactivatePipelineRequest)
Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the
deactivation process completes.
To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.
deactivatePipelineRequest - Contains the parameters for DeactivatePipeline.default CompletableFuture<DeactivatePipelineResponse> deactivatePipeline(Consumer<DeactivatePipelineRequest.Builder> deactivatePipelineRequest)
Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the
deactivation process completes.
To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.
This is a convenience which creates an instance of the DeactivatePipelineRequest.Builder avoiding the
need to create one manually via DeactivatePipelineRequest.builder()
deactivatePipelineRequest - A Consumer that will call methods on DeactivatePipelineInput.Builder to create a request.
Contains the parameters for DeactivatePipeline.default CompletableFuture<DeletePipelineResponse> deletePipeline(DeletePipelineRequest deletePipelineRequest)
Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.
Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a
pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual
components. Components that are paused by SetStatus can be resumed.
deletePipelineRequest - Contains the parameters for DeletePipeline.default CompletableFuture<DeletePipelineResponse> deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest)
Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.
Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a
pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual
components. Components that are paused by SetStatus can be resumed.
This is a convenience which creates an instance of the DeletePipelineRequest.Builder avoiding the need to
create one manually via DeletePipelineRequest.builder()
deletePipelineRequest - A Consumer that will call methods on DeletePipelineInput.Builder to create a request.
Contains the parameters for DeletePipeline.default CompletableFuture<DescribeObjectsResponse> describeObjects(DescribeObjectsRequest describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
describeObjectsRequest - Contains the parameters for DescribeObjects.default CompletableFuture<DescribeObjectsResponse> describeObjects(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
This is a convenience which creates an instance of the DescribeObjectsRequest.Builder avoiding the need
to create one manually via DescribeObjectsRequest.builder()
describeObjectsRequest - A Consumer that will call methods on DescribeObjectsInput.Builder to create a request.
Contains the parameters for DescribeObjects.default DescribeObjectsPublisher describeObjectsPaginator(DescribeObjectsRequest describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
This is a variant of
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsPublisher publisher = client.describeObjectsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsPublisher publisher = client.describeObjectsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datapipeline.model.DescribeObjectsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)
operation.
describeObjectsRequest - Contains the parameters for DescribeObjects.default DescribeObjectsPublisher describeObjectsPaginator(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest)
Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
This is a variant of
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsPublisher publisher = client.describeObjectsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsPublisher publisher = client.describeObjectsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datapipeline.model.DescribeObjectsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)
operation.
This is a convenience which creates an instance of the DescribeObjectsRequest.Builder avoiding the need
to create one manually via DescribeObjectsRequest.builder()
describeObjectsRequest - A Consumer that will call methods on DescribeObjectsInput.Builder to create a request.
Contains the parameters for DescribeObjects.default CompletableFuture<DescribePipelinesResponse> describePipelines(DescribePipelinesRequest describePipelinesRequest)
Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.
To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.
describePipelinesRequest - Contains the parameters for DescribePipelines.default CompletableFuture<DescribePipelinesResponse> describePipelines(Consumer<DescribePipelinesRequest.Builder> describePipelinesRequest)
Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.
To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.
This is a convenience which creates an instance of the DescribePipelinesRequest.Builder avoiding the need
to create one manually via DescribePipelinesRequest.builder()
describePipelinesRequest - A Consumer that will call methods on DescribePipelinesInput.Builder to create a request.
Contains the parameters for DescribePipelines.default CompletableFuture<EvaluateExpressionResponse> evaluateExpression(EvaluateExpressionRequest evaluateExpressionRequest)
Task runners call EvaluateExpression to evaluate a string in the context of the specified object.
For example, a task runner can evaluate SQL queries stored in Amazon S3.
evaluateExpressionRequest - Contains the parameters for EvaluateExpression.default CompletableFuture<EvaluateExpressionResponse> evaluateExpression(Consumer<EvaluateExpressionRequest.Builder> evaluateExpressionRequest)
Task runners call EvaluateExpression to evaluate a string in the context of the specified object.
For example, a task runner can evaluate SQL queries stored in Amazon S3.
This is a convenience which creates an instance of the EvaluateExpressionRequest.Builder avoiding the
need to create one manually via EvaluateExpressionRequest.builder()
evaluateExpressionRequest - A Consumer that will call methods on EvaluateExpressionInput.Builder to create a request.
Contains the parameters for EvaluateExpression.default CompletableFuture<GetPipelineDefinitionResponse> getPipelineDefinition(GetPipelineDefinitionRequest getPipelineDefinitionRequest)
Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the
pipeline definition that you provided using PutPipelineDefinition.
getPipelineDefinitionRequest - Contains the parameters for GetPipelineDefinition.default CompletableFuture<GetPipelineDefinitionResponse> getPipelineDefinition(Consumer<GetPipelineDefinitionRequest.Builder> getPipelineDefinitionRequest)
Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the
pipeline definition that you provided using PutPipelineDefinition.
This is a convenience which creates an instance of the GetPipelineDefinitionRequest.Builder avoiding the
need to create one manually via GetPipelineDefinitionRequest.builder()
getPipelineDefinitionRequest - A Consumer that will call methods on GetPipelineDefinitionInput.Builder to create a
request. Contains the parameters for GetPipelineDefinition.default CompletableFuture<ListPipelinesResponse> listPipelines(ListPipelinesRequest listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
listPipelinesRequest - Contains the parameters for ListPipelines.default CompletableFuture<ListPipelinesResponse> listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on ListPipelinesInput.Builder to create a request.
Contains the parameters for ListPipelines.default CompletableFuture<ListPipelinesResponse> listPipelines()
Lists the pipeline identifiers for all active pipelines that you have permission to access.
default ListPipelinesPublisher listPipelinesPaginator()
Lists the pipeline identifiers for all active pipelines that you have permission to access.
This is a variant of
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest) operation.
default ListPipelinesPublisher listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
This is a variant of
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest) operation.
listPipelinesRequest - Contains the parameters for ListPipelines.default ListPipelinesPublisher listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
This is a variant of
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesPublisher publisher = client.listPipelinesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest) operation.
This is a convenience which creates an instance of the ListPipelinesRequest.Builder avoiding the need to
create one manually via ListPipelinesRequest.builder()
listPipelinesRequest - A Consumer that will call methods on ListPipelinesInput.Builder to create a request.
Contains the parameters for ListPipelines.default CompletableFuture<PollForTaskResponse> pollForTask(PollForTaskRequest pollForTaskRequest)
Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner
specifies which tasks it can perform by setting a value for the workerGroup parameter. The task
returned can come from any of the pipelines that match the workerGroup value passed in by the task
runner and that was launched using the IAM user credentials specified by the task runner.
If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are
available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a
90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this,
set the socket timeout in your task runner to 90 seconds. The task runner should not call
PollForTask again on the same workerGroup until it receives a response, and this can
take up to 90 seconds.
pollForTaskRequest - Contains the parameters for PollForTask.default CompletableFuture<PollForTaskResponse> pollForTask(Consumer<PollForTaskRequest.Builder> pollForTaskRequest)
Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner
specifies which tasks it can perform by setting a value for the workerGroup parameter. The task
returned can come from any of the pipelines that match the workerGroup value passed in by the task
runner and that was launched using the IAM user credentials specified by the task runner.
If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are
available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a
90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this,
set the socket timeout in your task runner to 90 seconds. The task runner should not call
PollForTask again on the same workerGroup until it receives a response, and this can
take up to 90 seconds.
This is a convenience which creates an instance of the PollForTaskRequest.Builder avoiding the need to
create one manually via PollForTaskRequest.builder()
pollForTaskRequest - A Consumer that will call methods on PollForTaskInput.Builder to create a request.
Contains the parameters for PollForTask.default CompletableFuture<PutPipelineDefinitionResponse> putPipelineDefinition(PutPipelineDefinitionRequest putPipelineDefinitionRequest)
Adds tasks, schedules, and preconditions to the specified pipeline. You can use
PutPipelineDefinition to populate a new pipeline.
PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the
pipeline are saved unless one of the following three validation errors exists in the pipeline.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the
GetPipelineDefinition action.
putPipelineDefinitionRequest - Contains the parameters for PutPipelineDefinition.default CompletableFuture<PutPipelineDefinitionResponse> putPipelineDefinition(Consumer<PutPipelineDefinitionRequest.Builder> putPipelineDefinitionRequest)
Adds tasks, schedules, and preconditions to the specified pipeline. You can use
PutPipelineDefinition to populate a new pipeline.
PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the
pipeline are saved unless one of the following three validation errors exists in the pipeline.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the
GetPipelineDefinition action.
This is a convenience which creates an instance of the PutPipelineDefinitionRequest.Builder avoiding the
need to create one manually via PutPipelineDefinitionRequest.builder()
putPipelineDefinitionRequest - A Consumer that will call methods on PutPipelineDefinitionInput.Builder to create a
request. Contains the parameters for PutPipelineDefinition.default CompletableFuture<QueryObjectsResponse> queryObjects(QueryObjectsRequest queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
queryObjectsRequest - Contains the parameters for QueryObjects.default CompletableFuture<QueryObjectsResponse> queryObjects(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
This is a convenience which creates an instance of the QueryObjectsRequest.Builder avoiding the need to
create one manually via QueryObjectsRequest.builder()
queryObjectsRequest - A Consumer that will call methods on QueryObjectsInput.Builder to create a request.
Contains the parameters for QueryObjects.default QueryObjectsPublisher queryObjectsPaginator(QueryObjectsRequest queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
This is a variant of
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datapipeline.paginators.QueryObjectsPublisher publisher = client.queryObjectsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datapipeline.paginators.QueryObjectsPublisher publisher = client.queryObjectsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datapipeline.model.QueryObjectsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datapipeline.model.QueryObjectsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest) operation.
queryObjectsRequest - Contains the parameters for QueryObjects.default QueryObjectsPublisher queryObjectsPaginator(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
This is a variant of
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.datapipeline.paginators.QueryObjectsPublisher publisher = client.queryObjectsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.datapipeline.paginators.QueryObjectsPublisher publisher = client.queryObjectsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datapipeline.model.QueryObjectsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.datapipeline.model.QueryObjectsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest) operation.
This is a convenience which creates an instance of the QueryObjectsRequest.Builder avoiding the need to
create one manually via QueryObjectsRequest.builder()
queryObjectsRequest - A Consumer that will call methods on QueryObjectsInput.Builder to create a request.
Contains the parameters for QueryObjects.default CompletableFuture<RemoveTagsResponse> removeTags(RemoveTagsRequest removeTagsRequest)
Removes existing tags from the specified pipeline.
removeTagsRequest - Contains the parameters for RemoveTags.default CompletableFuture<RemoveTagsResponse> removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes existing tags from the specified pipeline.
This is a convenience which creates an instance of the RemoveTagsRequest.Builder avoiding the need to
create one manually via RemoveTagsRequest.builder()
removeTagsRequest - A Consumer that will call methods on RemoveTagsInput.Builder to create a request. Contains
the parameters for RemoveTags.default CompletableFuture<ReportTaskProgressResponse> reportTaskProgress(ReportTaskProgressRequest reportTaskProgressRequest)
Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If
the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent
PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every
15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by
specifying a reportProgressTimeout field in your pipeline.
If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is
unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners
should call ReportTaskProgress every 60 seconds.
reportTaskProgressRequest - Contains the parameters for ReportTaskProgress.default CompletableFuture<ReportTaskProgressResponse> reportTaskProgress(Consumer<ReportTaskProgressRequest.Builder> reportTaskProgressRequest)
Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If
the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent
PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every
15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by
specifying a reportProgressTimeout field in your pipeline.
If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is
unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners
should call ReportTaskProgress every 60 seconds.
This is a convenience which creates an instance of the ReportTaskProgressRequest.Builder avoiding the
need to create one manually via ReportTaskProgressRequest.builder()
reportTaskProgressRequest - A Consumer that will call methods on ReportTaskProgressInput.Builder to create a request.
Contains the parameters for ReportTaskProgress.default CompletableFuture<ReportTaskRunnerHeartbeatResponse> reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest)
Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational.
If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can
use this call to detect when the task runner application has failed and restart a new instance.
reportTaskRunnerHeartbeatRequest - Contains the parameters for ReportTaskRunnerHeartbeat.default CompletableFuture<ReportTaskRunnerHeartbeatResponse> reportTaskRunnerHeartbeat(Consumer<ReportTaskRunnerHeartbeatRequest.Builder> reportTaskRunnerHeartbeatRequest)
Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational.
If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can
use this call to detect when the task runner application has failed and restart a new instance.
This is a convenience which creates an instance of the ReportTaskRunnerHeartbeatRequest.Builder avoiding
the need to create one manually via ReportTaskRunnerHeartbeatRequest.builder()
reportTaskRunnerHeartbeatRequest - A Consumer that will call methods on ReportTaskRunnerHeartbeatInput.Builder to create a
request. Contains the parameters for ReportTaskRunnerHeartbeat.default CompletableFuture<SetStatusResponse> setStatus(SetStatusRequest setStatusRequest)
Requests that the status of the specified physical or logical pipeline objects be updated in the specified
pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set
depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on
FINISHED pipelines and attempting to do so returns InvalidRequestException.
setStatusRequest - Contains the parameters for SetStatus.default CompletableFuture<SetStatusResponse> setStatus(Consumer<SetStatusRequest.Builder> setStatusRequest)
Requests that the status of the specified physical or logical pipeline objects be updated in the specified
pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set
depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on
FINISHED pipelines and attempting to do so returns InvalidRequestException.
This is a convenience which creates an instance of the SetStatusRequest.Builder avoiding the need to
create one manually via SetStatusRequest.builder()
setStatusRequest - A Consumer that will call methods on SetStatusInput.Builder to create a request. Contains
the parameters for SetStatus.default CompletableFuture<SetTaskStatusResponse> setTaskStatus(SetTaskStatusRequest setTaskStatusRequest)
Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide
information about the final status. A task runner makes this call regardless of whether the task was sucessful. A
task runner does not need to call SetTaskStatus for tasks that are canceled by the web service
during a call to ReportTaskProgress.
setTaskStatusRequest - Contains the parameters for SetTaskStatus.default CompletableFuture<SetTaskStatusResponse> setTaskStatus(Consumer<SetTaskStatusRequest.Builder> setTaskStatusRequest)
Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide
information about the final status. A task runner makes this call regardless of whether the task was sucessful. A
task runner does not need to call SetTaskStatus for tasks that are canceled by the web service
during a call to ReportTaskProgress.
This is a convenience which creates an instance of the SetTaskStatusRequest.Builder avoiding the need to
create one manually via SetTaskStatusRequest.builder()
setTaskStatusRequest - A Consumer that will call methods on SetTaskStatusInput.Builder to create a request.
Contains the parameters for SetTaskStatus.default CompletableFuture<ValidatePipelineDefinitionResponse> validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest)
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
validatePipelineDefinitionRequest - Contains the parameters for ValidatePipelineDefinition.default CompletableFuture<ValidatePipelineDefinitionResponse> validatePipelineDefinition(Consumer<ValidatePipelineDefinitionRequest.Builder> validatePipelineDefinitionRequest)
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
This is a convenience which creates an instance of the ValidatePipelineDefinitionRequest.Builder avoiding
the need to create one manually via ValidatePipelineDefinitionRequest.builder()
validatePipelineDefinitionRequest - A Consumer that will call methods on ValidatePipelineDefinitionInput.Builder to create a
request. Contains the parameters for ValidatePipelineDefinition.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.