Class AbstractDataPipelineAsync
- All Implemented Interfaces:
DataPipeline
,DataPipelineAsync
DataPipelineAsync
. Convenient method forms
pass through to the corresponding overload that takes a request object and an
AsyncHandler
, which throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionValidates the specified pipeline and starts processing pipeline tasks.activatePipelineAsync
(ActivatePipelineRequest request, AsyncHandler<ActivatePipelineRequest, ActivatePipelineResult> asyncHandler) Validates the specified pipeline and starts processing pipeline tasks.addTagsAsync
(AddTagsRequest request) Adds or modifies tags for the specified pipeline.addTagsAsync
(AddTagsRequest request, AsyncHandler<AddTagsRequest, AddTagsResult> asyncHandler) Adds or modifies tags for the specified pipeline.createPipelineAsync
(CreatePipelineRequest request) Creates a new, empty pipeline.createPipelineAsync
(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest, CreatePipelineResult> asyncHandler) Creates a new, empty pipeline.Deactivates the specified running pipeline.deactivatePipelineAsync
(DeactivatePipelineRequest request, AsyncHandler<DeactivatePipelineRequest, DeactivatePipelineResult> asyncHandler) Deactivates the specified running pipeline.deletePipelineAsync
(DeletePipelineRequest request) Deletes a pipeline, its pipeline definition, and its run history.deletePipelineAsync
(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest, DeletePipelineResult> asyncHandler) Deletes a pipeline, its pipeline definition, and its run history.Gets the object definitions for a set of objects associated with the pipeline.describeObjectsAsync
(DescribeObjectsRequest request, AsyncHandler<DescribeObjectsRequest, DescribeObjectsResult> asyncHandler) Gets the object definitions for a set of objects associated with the pipeline.Retrieves metadata about one or more pipelines.describePipelinesAsync
(DescribePipelinesRequest request, AsyncHandler<DescribePipelinesRequest, DescribePipelinesResult> asyncHandler) Retrieves metadata about one or more pipelines.Task runners callEvaluateExpression
to evaluate a string in the context of the specified object.evaluateExpressionAsync
(EvaluateExpressionRequest request, AsyncHandler<EvaluateExpressionRequest, EvaluateExpressionResult> asyncHandler) Task runners callEvaluateExpression
to evaluate a string in the context of the specified object.Gets the definition of the specified pipeline.getPipelineDefinitionAsync
(GetPipelineDefinitionRequest request, AsyncHandler<GetPipelineDefinitionRequest, GetPipelineDefinitionResult> asyncHandler) Gets the definition of the specified pipeline.Simplified method form for invoking the ListPipelines operation.listPipelinesAsync
(AsyncHandler<ListPipelinesRequest, ListPipelinesResult> asyncHandler) Simplified method form for invoking the ListPipelines operation with an AsyncHandler.listPipelinesAsync
(ListPipelinesRequest request) Lists the pipeline identifiers for all active pipelines that you have permission to access.listPipelinesAsync
(ListPipelinesRequest request, AsyncHandler<ListPipelinesRequest, ListPipelinesResult> asyncHandler) Lists the pipeline identifiers for all active pipelines that you have permission to access.pollForTaskAsync
(PollForTaskRequest request) Task runners callPollForTask
to receive a task to perform from AWS Data Pipeline.pollForTaskAsync
(PollForTaskRequest request, AsyncHandler<PollForTaskRequest, PollForTaskResult> asyncHandler) Task runners callPollForTask
to receive a task to perform from AWS Data Pipeline.Adds tasks, schedules, and preconditions to the specified pipeline.putPipelineDefinitionAsync
(PutPipelineDefinitionRequest request, AsyncHandler<PutPipelineDefinitionRequest, PutPipelineDefinitionResult> asyncHandler) Adds tasks, schedules, and preconditions to the specified pipeline.queryObjectsAsync
(QueryObjectsRequest request) Queries the specified pipeline for the names of objects that match the specified set of conditions.queryObjectsAsync
(QueryObjectsRequest request, AsyncHandler<QueryObjectsRequest, QueryObjectsResult> asyncHandler) Queries the specified pipeline for the names of objects that match the specified set of conditions.removeTagsAsync
(RemoveTagsRequest request) Removes existing tags from the specified pipeline.removeTagsAsync
(RemoveTagsRequest request, AsyncHandler<RemoveTagsRequest, RemoveTagsResult> asyncHandler) Removes existing tags from the specified pipeline.Task runners callReportTaskProgress
when assigned a task to acknowledge that it has the task.reportTaskProgressAsync
(ReportTaskProgressRequest request, AsyncHandler<ReportTaskProgressRequest, ReportTaskProgressResult> asyncHandler) Task runners callReportTaskProgress
when assigned a task to acknowledge that it has the task.Task runners callReportTaskRunnerHeartbeat
every 15 minutes to indicate that they are operational.reportTaskRunnerHeartbeatAsync
(ReportTaskRunnerHeartbeatRequest request, AsyncHandler<ReportTaskRunnerHeartbeatRequest, ReportTaskRunnerHeartbeatResult> asyncHandler) Task runners callReportTaskRunnerHeartbeat
every 15 minutes to indicate that they are operational.setStatusAsync
(SetStatusRequest request) Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.setStatusAsync
(SetStatusRequest request, AsyncHandler<SetStatusRequest, SetStatusResult> asyncHandler) Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.setTaskStatusAsync
(SetTaskStatusRequest request) Task runners callSetTaskStatus
to notify AWS Data Pipeline that a task is completed and provide information about the final status.setTaskStatusAsync
(SetTaskStatusRequest request, AsyncHandler<SetTaskStatusRequest, SetTaskStatusResult> asyncHandler) Task runners callSetTaskStatus
to notify AWS Data Pipeline that a task is completed and provide information about the final status.Validates the specified pipeline definition to ensure that it is well formed and can be run without error.validatePipelineDefinitionAsync
(ValidatePipelineDefinitionRequest request, AsyncHandler<ValidatePipelineDefinitionRequest, ValidatePipelineDefinitionResult> asyncHandler) Validates the specified pipeline definition to ensure that it is well formed and can be run without error.Methods inherited from class com.amazonaws.services.datapipeline.AbstractDataPipeline
activatePipeline, addTags, createPipeline, deactivatePipeline, deletePipeline, describeObjects, describePipelines, evaluateExpression, getCachedResponseMetadata, getPipelineDefinition, listPipelines, listPipelines, pollForTask, putPipelineDefinition, queryObjects, removeTags, reportTaskProgress, reportTaskRunnerHeartbeat, setEndpoint, setRegion, setStatus, setTaskStatus, shutdown, validatePipelineDefinition
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.datapipeline.DataPipeline
activatePipeline, addTags, createPipeline, deactivatePipeline, deletePipeline, describeObjects, describePipelines, evaluateExpression, getCachedResponseMetadata, getPipelineDefinition, listPipelines, listPipelines, pollForTask, putPipelineDefinition, queryObjects, removeTags, reportTaskProgress, reportTaskRunnerHeartbeat, setEndpoint, setRegion, setStatus, setTaskStatus, shutdown, validatePipelineDefinition
-
Constructor Details
-
AbstractDataPipelineAsync
protected AbstractDataPipelineAsync()
-
-
Method Details
-
activatePipelineAsync
Description copied from interface:DataPipelineAsync
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.
- Specified by:
activatePipelineAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ActivatePipeline.- Returns:
- A Java Future containing the result of the ActivatePipeline operation returned by the service.
-
activatePipelineAsync
public Future<ActivatePipelineResult> activatePipelineAsync(ActivatePipelineRequest request, AsyncHandler<ActivatePipelineRequest, ActivatePipelineResult> asyncHandler) Description copied from interface:DataPipelineAsync
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.
- Specified by:
activatePipelineAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ActivatePipeline.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ActivatePipeline operation returned by the service.
-
addTagsAsync
Description copied from interface:DataPipelineAsync
Adds or modifies tags for the specified pipeline.
- Specified by:
addTagsAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for AddTags.- Returns:
- A Java Future containing the result of the AddTags operation returned by the service.
-
addTagsAsync
public Future<AddTagsResult> addTagsAsync(AddTagsRequest request, AsyncHandler<AddTagsRequest, AddTagsResult> asyncHandler) Description copied from interface:DataPipelineAsync
Adds or modifies tags for the specified pipeline.
- Specified by:
addTagsAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for AddTags.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the AddTags operation returned by the service.
-
createPipelineAsync
Description copied from interface:DataPipelineAsync
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
- Specified by:
createPipelineAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for CreatePipeline.- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
-
createPipelineAsync
public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest, CreatePipelineResult> asyncHandler) Description copied from interface:DataPipelineAsync
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
- Specified by:
createPipelineAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for CreatePipeline.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreatePipeline operation returned by the service.
-
deactivatePipelineAsync
Description copied from interface:DataPipelineAsync
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.
- Specified by:
deactivatePipelineAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for DeactivatePipeline.- Returns:
- A Java Future containing the result of the DeactivatePipeline operation returned by the service.
-
deactivatePipelineAsync
public Future<DeactivatePipelineResult> deactivatePipelineAsync(DeactivatePipelineRequest request, AsyncHandler<DeactivatePipelineRequest, DeactivatePipelineResult> asyncHandler) Description copied from interface:DataPipelineAsync
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.
- Specified by:
deactivatePipelineAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for DeactivatePipeline.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeactivatePipeline operation returned by the service.
-
deletePipelineAsync
Description copied from interface:DataPipelineAsync
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.- Specified by:
deletePipelineAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for DeletePipeline.- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
-
deletePipelineAsync
public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest, DeletePipelineResult> asyncHandler) Description copied from interface:DataPipelineAsync
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.- Specified by:
deletePipelineAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for DeletePipeline.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeletePipeline operation returned by the service.
-
describeObjectsAsync
Description copied from interface:DataPipelineAsync
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.
- Specified by:
describeObjectsAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for DescribeObjects.- Returns:
- A Java Future containing the result of the DescribeObjects operation returned by the service.
-
describeObjectsAsync
public Future<DescribeObjectsResult> describeObjectsAsync(DescribeObjectsRequest request, AsyncHandler<DescribeObjectsRequest, DescribeObjectsResult> asyncHandler) Description copied from interface:DataPipelineAsync
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.
- Specified by:
describeObjectsAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for DescribeObjects.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeObjects operation returned by the service.
-
describePipelinesAsync
Description copied from interface:DataPipelineAsync
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.
- Specified by:
describePipelinesAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for DescribePipelines.- Returns:
- A Java Future containing the result of the DescribePipelines operation returned by the service.
-
describePipelinesAsync
public Future<DescribePipelinesResult> describePipelinesAsync(DescribePipelinesRequest request, AsyncHandler<DescribePipelinesRequest, DescribePipelinesResult> asyncHandler) Description copied from interface:DataPipelineAsync
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.
- Specified by:
describePipelinesAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for DescribePipelines.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribePipelines operation returned by the service.
-
evaluateExpressionAsync
Description copied from interface:DataPipelineAsync
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.- Specified by:
evaluateExpressionAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for EvaluateExpression.- Returns:
- A Java Future containing the result of the EvaluateExpression operation returned by the service.
-
evaluateExpressionAsync
public Future<EvaluateExpressionResult> evaluateExpressionAsync(EvaluateExpressionRequest request, AsyncHandler<EvaluateExpressionRequest, EvaluateExpressionResult> asyncHandler) Description copied from interface:DataPipelineAsync
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.- Specified by:
evaluateExpressionAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for EvaluateExpression.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the EvaluateExpression operation returned by the service.
-
getPipelineDefinitionAsync
public Future<GetPipelineDefinitionResult> getPipelineDefinitionAsync(GetPipelineDefinitionRequest request) Description copied from interface:DataPipelineAsync
Gets the definition of the specified pipeline. You can call
GetPipelineDefinition
to retrieve the pipeline definition that you provided using PutPipelineDefinition.- Specified by:
getPipelineDefinitionAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for GetPipelineDefinition.- Returns:
- A Java Future containing the result of the GetPipelineDefinition operation returned by the service.
-
getPipelineDefinitionAsync
public Future<GetPipelineDefinitionResult> getPipelineDefinitionAsync(GetPipelineDefinitionRequest request, AsyncHandler<GetPipelineDefinitionRequest, GetPipelineDefinitionResult> asyncHandler) Description copied from interface:DataPipelineAsync
Gets the definition of the specified pipeline. You can call
GetPipelineDefinition
to retrieve the pipeline definition that you provided using PutPipelineDefinition.- Specified by:
getPipelineDefinitionAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for GetPipelineDefinition.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GetPipelineDefinition operation returned by the service.
-
listPipelinesAsync
Description copied from interface:DataPipelineAsync
Lists the pipeline identifiers for all active pipelines that you have permission to access.
- Specified by:
listPipelinesAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ListPipelines.- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
-
listPipelinesAsync
public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request, AsyncHandler<ListPipelinesRequest, ListPipelinesResult> asyncHandler) Description copied from interface:DataPipelineAsync
Lists the pipeline identifiers for all active pipelines that you have permission to access.
- Specified by:
listPipelinesAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ListPipelines.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListPipelines operation returned by the service.
-
listPipelinesAsync
Simplified method form for invoking the ListPipelines operation.- Specified by:
listPipelinesAsync
in interfaceDataPipelineAsync
- See Also:
-
listPipelinesAsync
public Future<ListPipelinesResult> listPipelinesAsync(AsyncHandler<ListPipelinesRequest, ListPipelinesResult> asyncHandler) Simplified method form for invoking the ListPipelines operation with an AsyncHandler.- Specified by:
listPipelinesAsync
in interfaceDataPipelineAsync
- See Also:
-
pollForTaskAsync
Description copied from interface:DataPipelineAsync
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 theworkerGroup
parameter. The task returned can come from any of the pipelines that match theworkerGroup
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 callPollForTask
again on the sameworkerGroup
until it receives a response, and this can take up to 90 seconds.- Specified by:
pollForTaskAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for PollForTask.- Returns:
- A Java Future containing the result of the PollForTask operation returned by the service.
-
pollForTaskAsync
public Future<PollForTaskResult> pollForTaskAsync(PollForTaskRequest request, AsyncHandler<PollForTaskRequest, PollForTaskResult> asyncHandler) Description copied from interface:DataPipelineAsync
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 theworkerGroup
parameter. The task returned can come from any of the pipelines that match theworkerGroup
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 callPollForTask
again on the sameworkerGroup
until it receives a response, and this can take up to 90 seconds.- Specified by:
pollForTaskAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for PollForTask.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PollForTask operation returned by the service.
-
putPipelineDefinitionAsync
public Future<PutPipelineDefinitionResult> putPipelineDefinitionAsync(PutPipelineDefinitionRequest request) Description copied from interface:DataPipelineAsync
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.- An object is missing a name or identifier field.
- A string or reference field is empty.
- The number of objects in the pipeline exceeds the maximum allowed objects.
- The pipeline is in a FINISHED state.
Pipeline object definitions are passed to the
PutPipelineDefinition
action and returned by the GetPipelineDefinition action.- Specified by:
putPipelineDefinitionAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for PutPipelineDefinition.- Returns:
- A Java Future containing the result of the PutPipelineDefinition operation returned by the service.
-
putPipelineDefinitionAsync
public Future<PutPipelineDefinitionResult> putPipelineDefinitionAsync(PutPipelineDefinitionRequest request, AsyncHandler<PutPipelineDefinitionRequest, PutPipelineDefinitionResult> asyncHandler) Description copied from interface:DataPipelineAsync
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.- An object is missing a name or identifier field.
- A string or reference field is empty.
- The number of objects in the pipeline exceeds the maximum allowed objects.
- The pipeline is in a FINISHED state.
Pipeline object definitions are passed to the
PutPipelineDefinition
action and returned by the GetPipelineDefinition action.- Specified by:
putPipelineDefinitionAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for PutPipelineDefinition.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PutPipelineDefinition operation returned by the service.
-
queryObjectsAsync
Description copied from interface:DataPipelineAsync
Queries the specified pipeline for the names of objects that match the specified set of conditions.
- Specified by:
queryObjectsAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for QueryObjects.- Returns:
- A Java Future containing the result of the QueryObjects operation returned by the service.
-
queryObjectsAsync
public Future<QueryObjectsResult> queryObjectsAsync(QueryObjectsRequest request, AsyncHandler<QueryObjectsRequest, QueryObjectsResult> asyncHandler) Description copied from interface:DataPipelineAsync
Queries the specified pipeline for the names of objects that match the specified set of conditions.
- Specified by:
queryObjectsAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for QueryObjects.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the QueryObjects operation returned by the service.
-
removeTagsAsync
Description copied from interface:DataPipelineAsync
Removes existing tags from the specified pipeline.
- Specified by:
removeTagsAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for RemoveTags.- Returns:
- A Java Future containing the result of the RemoveTags operation returned by the service.
-
removeTagsAsync
public Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest request, AsyncHandler<RemoveTagsRequest, RemoveTagsResult> asyncHandler) Description copied from interface:DataPipelineAsync
Removes existing tags from the specified pipeline.
- Specified by:
removeTagsAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for RemoveTags.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the RemoveTags operation returned by the service.
-
reportTaskProgressAsync
Description copied from interface:DataPipelineAsync
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 areportProgressTimeout
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.- Specified by:
reportTaskProgressAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ReportTaskProgress.- Returns:
- A Java Future containing the result of the ReportTaskProgress operation returned by the service.
-
reportTaskProgressAsync
public Future<ReportTaskProgressResult> reportTaskProgressAsync(ReportTaskProgressRequest request, AsyncHandler<ReportTaskProgressRequest, ReportTaskProgressResult> asyncHandler) Description copied from interface:DataPipelineAsync
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 areportProgressTimeout
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.- Specified by:
reportTaskProgressAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ReportTaskProgress.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ReportTaskProgress operation returned by the service.
-
reportTaskRunnerHeartbeatAsync
public Future<ReportTaskRunnerHeartbeatResult> reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest request) Description copied from interface:DataPipelineAsync
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.- Specified by:
reportTaskRunnerHeartbeatAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ReportTaskRunnerHeartbeat.- Returns:
- A Java Future containing the result of the ReportTaskRunnerHeartbeat operation returned by the service.
-
reportTaskRunnerHeartbeatAsync
public Future<ReportTaskRunnerHeartbeatResult> reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest request, AsyncHandler<ReportTaskRunnerHeartbeatRequest, ReportTaskRunnerHeartbeatResult> asyncHandler) Description copied from interface:DataPipelineAsync
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.- Specified by:
reportTaskRunnerHeartbeatAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ReportTaskRunnerHeartbeat.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ReportTaskRunnerHeartbeat operation returned by the service.
-
setStatusAsync
Description copied from interface:DataPipelineAsync
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 returnsInvalidRequestException
.- Specified by:
setStatusAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for SetStatus.- Returns:
- A Java Future containing the result of the SetStatus operation returned by the service.
-
setStatusAsync
public Future<SetStatusResult> setStatusAsync(SetStatusRequest request, AsyncHandler<SetStatusRequest, SetStatusResult> asyncHandler) Description copied from interface:DataPipelineAsync
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 returnsInvalidRequestException
.- Specified by:
setStatusAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for SetStatus.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the SetStatus operation returned by the service.
-
setTaskStatusAsync
Description copied from interface:DataPipelineAsync
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 callSetTaskStatus
for tasks that are canceled by the web service during a call to ReportTaskProgress.- Specified by:
setTaskStatusAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for SetTaskStatus.- Returns:
- A Java Future containing the result of the SetTaskStatus operation returned by the service.
-
setTaskStatusAsync
public Future<SetTaskStatusResult> setTaskStatusAsync(SetTaskStatusRequest request, AsyncHandler<SetTaskStatusRequest, SetTaskStatusResult> asyncHandler) Description copied from interface:DataPipelineAsync
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 callSetTaskStatus
for tasks that are canceled by the web service during a call to ReportTaskProgress.- Specified by:
setTaskStatusAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for SetTaskStatus.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the SetTaskStatus operation returned by the service.
-
validatePipelineDefinitionAsync
public Future<ValidatePipelineDefinitionResult> validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest request) Description copied from interface:DataPipelineAsync
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
- Specified by:
validatePipelineDefinitionAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ValidatePipelineDefinition.- Returns:
- A Java Future containing the result of the ValidatePipelineDefinition operation returned by the service.
-
validatePipelineDefinitionAsync
public Future<ValidatePipelineDefinitionResult> validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest request, AsyncHandler<ValidatePipelineDefinitionRequest, ValidatePipelineDefinitionResult> asyncHandler) Description copied from interface:DataPipelineAsync
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
- Specified by:
validatePipelineDefinitionAsync
in interfaceDataPipelineAsync
- Parameters:
request
- Contains the parameters for ValidatePipelineDefinition.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ValidatePipelineDefinition operation returned by the service.
-