Class AbstractDataPipelineAsync
- java.lang.Object
-
- com.amazonaws.services.datapipeline.AbstractDataPipeline
-
- com.amazonaws.services.datapipeline.AbstractDataPipelineAsync
-
- All Implemented Interfaces:
DataPipeline,DataPipelineAsync
public class AbstractDataPipelineAsync extends AbstractDataPipeline implements DataPipelineAsync
Abstract implementation ofDataPipelineAsync. Convenient method forms pass through to the corresponding overload that takes a request object and anAsyncHandler, which throws anUnsupportedOperationException.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractDataPipelineAsync()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Future<ActivatePipelineResult>activatePipelineAsync(ActivatePipelineRequest request)Validates the specified pipeline and starts processing pipeline tasks.Future<ActivatePipelineResult>activatePipelineAsync(ActivatePipelineRequest request, AsyncHandler<ActivatePipelineRequest,ActivatePipelineResult> asyncHandler)Validates the specified pipeline and starts processing pipeline tasks.Future<AddTagsResult>addTagsAsync(AddTagsRequest request)Adds or modifies tags for the specified pipeline.Future<AddTagsResult>addTagsAsync(AddTagsRequest request, AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)Adds or modifies tags for the specified pipeline.Future<CreatePipelineResult>createPipelineAsync(CreatePipelineRequest request)Creates a new, empty pipeline.Future<CreatePipelineResult>createPipelineAsync(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)Creates a new, empty pipeline.Future<DeactivatePipelineResult>deactivatePipelineAsync(DeactivatePipelineRequest request)Deactivates the specified running pipeline.Future<DeactivatePipelineResult>deactivatePipelineAsync(DeactivatePipelineRequest request, AsyncHandler<DeactivatePipelineRequest,DeactivatePipelineResult> asyncHandler)Deactivates the specified running pipeline.Future<DeletePipelineResult>deletePipelineAsync(DeletePipelineRequest request)Deletes a pipeline, its pipeline definition, and its run history.Future<DeletePipelineResult>deletePipelineAsync(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)Deletes a pipeline, its pipeline definition, and its run history.Future<DescribeObjectsResult>describeObjectsAsync(DescribeObjectsRequest request)Gets the object definitions for a set of objects associated with the pipeline.Future<DescribeObjectsResult>describeObjectsAsync(DescribeObjectsRequest request, AsyncHandler<DescribeObjectsRequest,DescribeObjectsResult> asyncHandler)Gets the object definitions for a set of objects associated with the pipeline.Future<DescribePipelinesResult>describePipelinesAsync(DescribePipelinesRequest request)Retrieves metadata about one or more pipelines.Future<DescribePipelinesResult>describePipelinesAsync(DescribePipelinesRequest request, AsyncHandler<DescribePipelinesRequest,DescribePipelinesResult> asyncHandler)Retrieves metadata about one or more pipelines.Future<EvaluateExpressionResult>evaluateExpressionAsync(EvaluateExpressionRequest request)Task runners callEvaluateExpressionto evaluate a string in the context of the specified object.Future<EvaluateExpressionResult>evaluateExpressionAsync(EvaluateExpressionRequest request, AsyncHandler<EvaluateExpressionRequest,EvaluateExpressionResult> asyncHandler)Task runners callEvaluateExpressionto evaluate a string in the context of the specified object.Future<GetPipelineDefinitionResult>getPipelineDefinitionAsync(GetPipelineDefinitionRequest request)Gets the definition of the specified pipeline.Future<GetPipelineDefinitionResult>getPipelineDefinitionAsync(GetPipelineDefinitionRequest request, AsyncHandler<GetPipelineDefinitionRequest,GetPipelineDefinitionResult> asyncHandler)Gets the definition of the specified pipeline.Future<ListPipelinesResult>listPipelinesAsync()Simplified method form for invoking the ListPipelines operation.Future<ListPipelinesResult>listPipelinesAsync(AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)Simplified method form for invoking the ListPipelines operation with an AsyncHandler.Future<ListPipelinesResult>listPipelinesAsync(ListPipelinesRequest request)Lists the pipeline identifiers for all active pipelines that you have permission to access.Future<ListPipelinesResult>listPipelinesAsync(ListPipelinesRequest request, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)Lists the pipeline identifiers for all active pipelines that you have permission to access.Future<PollForTaskResult>pollForTaskAsync(PollForTaskRequest request)Task runners callPollForTaskto receive a task to perform from AWS Data Pipeline.Future<PollForTaskResult>pollForTaskAsync(PollForTaskRequest request, AsyncHandler<PollForTaskRequest,PollForTaskResult> asyncHandler)Task runners callPollForTaskto receive a task to perform from AWS Data Pipeline.Future<PutPipelineDefinitionResult>putPipelineDefinitionAsync(PutPipelineDefinitionRequest request)Adds tasks, schedules, and preconditions to the specified pipeline.Future<PutPipelineDefinitionResult>putPipelineDefinitionAsync(PutPipelineDefinitionRequest request, AsyncHandler<PutPipelineDefinitionRequest,PutPipelineDefinitionResult> asyncHandler)Adds tasks, schedules, and preconditions to the specified pipeline.Future<QueryObjectsResult>queryObjectsAsync(QueryObjectsRequest request)Queries the specified pipeline for the names of objects that match the specified set of conditions.Future<QueryObjectsResult>queryObjectsAsync(QueryObjectsRequest request, AsyncHandler<QueryObjectsRequest,QueryObjectsResult> asyncHandler)Queries the specified pipeline for the names of objects that match the specified set of conditions.Future<RemoveTagsResult>removeTagsAsync(RemoveTagsRequest request)Removes existing tags from the specified pipeline.Future<RemoveTagsResult>removeTagsAsync(RemoveTagsRequest request, AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)Removes existing tags from the specified pipeline.Future<ReportTaskProgressResult>reportTaskProgressAsync(ReportTaskProgressRequest request)Task runners callReportTaskProgresswhen assigned a task to acknowledge that it has the task.Future<ReportTaskProgressResult>reportTaskProgressAsync(ReportTaskProgressRequest request, AsyncHandler<ReportTaskProgressRequest,ReportTaskProgressResult> asyncHandler)Task runners callReportTaskProgresswhen assigned a task to acknowledge that it has the task.Future<ReportTaskRunnerHeartbeatResult>reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest request)Task runners callReportTaskRunnerHeartbeatevery 15 minutes to indicate that they are operational.Future<ReportTaskRunnerHeartbeatResult>reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest request, AsyncHandler<ReportTaskRunnerHeartbeatRequest,ReportTaskRunnerHeartbeatResult> asyncHandler)Task runners callReportTaskRunnerHeartbeatevery 15 minutes to indicate that they are operational.Future<SetStatusResult>setStatusAsync(SetStatusRequest request)Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.Future<SetStatusResult>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.Future<SetTaskStatusResult>setTaskStatusAsync(SetTaskStatusRequest request)Task runners callSetTaskStatusto notify AWS Data Pipeline that a task is completed and provide information about the final status.Future<SetTaskStatusResult>setTaskStatusAsync(SetTaskStatusRequest request, AsyncHandler<SetTaskStatusRequest,SetTaskStatusResult> asyncHandler)Task runners callSetTaskStatusto notify AWS Data Pipeline that a task is completed and provide information about the final status.Future<ValidatePipelineDefinitionResult>validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest request)Validates the specified pipeline definition to ensure that it is well formed and can be run without error.Future<ValidatePipelineDefinitionResult>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
-
-
-
-
Method Detail
-
activatePipelineAsync
public Future<ActivatePipelineResult> activatePipelineAsync(ActivatePipelineRequest request)
Description copied from interface:DataPipelineAsyncValidates 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:
activatePipelineAsyncin 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:DataPipelineAsyncValidates 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:
activatePipelineAsyncin 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
public Future<AddTagsResult> addTagsAsync(AddTagsRequest request)
Description copied from interface:DataPipelineAsyncAdds or modifies tags for the specified pipeline.
- Specified by:
addTagsAsyncin 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:DataPipelineAsyncAdds or modifies tags for the specified pipeline.
- Specified by:
addTagsAsyncin 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
public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request)
Description copied from interface:DataPipelineAsyncCreates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
- Specified by:
createPipelineAsyncin 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:DataPipelineAsyncCreates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
- Specified by:
createPipelineAsyncin 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
public Future<DeactivatePipelineResult> deactivatePipelineAsync(DeactivatePipelineRequest request)
Description copied from interface:DataPipelineAsyncDeactivates the specified running pipeline. The pipeline is set to the
DEACTIVATINGstate 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:
deactivatePipelineAsyncin 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:DataPipelineAsyncDeactivates the specified running pipeline. The pipeline is set to the
DEACTIVATINGstate 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:
deactivatePipelineAsyncin 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
public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request)
Description copied from interface:DataPipelineAsyncDeletes 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
PAUSEon individual components. Components that are paused by SetStatus can be resumed.- Specified by:
deletePipelineAsyncin 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:DataPipelineAsyncDeletes 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
PAUSEon individual components. Components that are paused by SetStatus can be resumed.- Specified by:
deletePipelineAsyncin 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
public Future<DescribeObjectsResult> describeObjectsAsync(DescribeObjectsRequest request)
Description copied from interface:DataPipelineAsyncGets 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:
describeObjectsAsyncin 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:DataPipelineAsyncGets 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:
describeObjectsAsyncin 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
public Future<DescribePipelinesResult> describePipelinesAsync(DescribePipelinesRequest request)
Description copied from interface:DataPipelineAsyncRetrieves 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:
describePipelinesAsyncin 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:DataPipelineAsyncRetrieves 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:
describePipelinesAsyncin 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
public Future<EvaluateExpressionResult> evaluateExpressionAsync(EvaluateExpressionRequest request)
Description copied from interface:DataPipelineAsyncTask runners call
EvaluateExpressionto 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:
evaluateExpressionAsyncin 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:DataPipelineAsyncTask runners call
EvaluateExpressionto 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:
evaluateExpressionAsyncin 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:DataPipelineAsyncGets the definition of the specified pipeline. You can call
GetPipelineDefinitionto retrieve the pipeline definition that you provided using PutPipelineDefinition.- Specified by:
getPipelineDefinitionAsyncin 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:DataPipelineAsyncGets the definition of the specified pipeline. You can call
GetPipelineDefinitionto retrieve the pipeline definition that you provided using PutPipelineDefinition.- Specified by:
getPipelineDefinitionAsyncin 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
public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request)
Description copied from interface:DataPipelineAsyncLists the pipeline identifiers for all active pipelines that you have permission to access.
- Specified by:
listPipelinesAsyncin 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:DataPipelineAsyncLists the pipeline identifiers for all active pipelines that you have permission to access.
- Specified by:
listPipelinesAsyncin 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
public Future<ListPipelinesResult> listPipelinesAsync()
Simplified method form for invoking the ListPipelines operation.- Specified by:
listPipelinesAsyncin interfaceDataPipelineAsync- See Also:
listPipelinesAsync(ListPipelinesRequest)
-
listPipelinesAsync
public Future<ListPipelinesResult> listPipelinesAsync(AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
Simplified method form for invoking the ListPipelines operation with an AsyncHandler.- Specified by:
listPipelinesAsyncin interfaceDataPipelineAsync- See Also:
listPipelinesAsync(ListPipelinesRequest, com.amazonaws.handlers.AsyncHandler)
-
pollForTaskAsync
public Future<PollForTaskResult> pollForTaskAsync(PollForTaskRequest request)
Description copied from interface:DataPipelineAsyncTask runners call
PollForTaskto receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for theworkerGroupparameter. The task returned can come from any of the pipelines that match theworkerGroupvalue 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,
PollForTaskreturns a response immediately. If no tasks are available in the queue,PollForTaskuses 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 callPollForTaskagain on the sameworkerGroupuntil it receives a response, and this can take up to 90 seconds.- Specified by:
pollForTaskAsyncin 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:DataPipelineAsyncTask runners call
PollForTaskto receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for theworkerGroupparameter. The task returned can come from any of the pipelines that match theworkerGroupvalue 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,
PollForTaskreturns a response immediately. If no tasks are available in the queue,PollForTaskuses 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 callPollForTaskagain on the sameworkerGroupuntil it receives a response, and this can take up to 90 seconds.- Specified by:
pollForTaskAsyncin 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:DataPipelineAsyncAdds tasks, schedules, and preconditions to the specified pipeline. You can use
PutPipelineDefinitionto populate a new pipeline.PutPipelineDefinitionalso 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
PutPipelineDefinitionaction and returned by the GetPipelineDefinition action.- Specified by:
putPipelineDefinitionAsyncin 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:DataPipelineAsyncAdds tasks, schedules, and preconditions to the specified pipeline. You can use
PutPipelineDefinitionto populate a new pipeline.PutPipelineDefinitionalso 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
PutPipelineDefinitionaction and returned by the GetPipelineDefinition action.- Specified by:
putPipelineDefinitionAsyncin 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
public Future<QueryObjectsResult> queryObjectsAsync(QueryObjectsRequest request)
Description copied from interface:DataPipelineAsyncQueries the specified pipeline for the names of objects that match the specified set of conditions.
- Specified by:
queryObjectsAsyncin 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:DataPipelineAsyncQueries the specified pipeline for the names of objects that match the specified set of conditions.
- Specified by:
queryObjectsAsyncin 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
public Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest request)
Description copied from interface:DataPipelineAsyncRemoves existing tags from the specified pipeline.
- Specified by:
removeTagsAsyncin 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:DataPipelineAsyncRemoves existing tags from the specified pipeline.
- Specified by:
removeTagsAsyncin 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
public Future<ReportTaskProgressResult> reportTaskProgressAsync(ReportTaskProgressRequest request)
Description copied from interface:DataPipelineAsyncTask runners call
ReportTaskProgresswhen 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 areportProgressTimeoutfield 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
ReportTaskProgressevery 60 seconds.- Specified by:
reportTaskProgressAsyncin 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:DataPipelineAsyncTask runners call
ReportTaskProgresswhen 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 areportProgressTimeoutfield 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
ReportTaskProgressevery 60 seconds.- Specified by:
reportTaskProgressAsyncin 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:DataPipelineAsyncTask runners call
ReportTaskRunnerHeartbeatevery 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:
reportTaskRunnerHeartbeatAsyncin 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:DataPipelineAsyncTask runners call
ReportTaskRunnerHeartbeatevery 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:
reportTaskRunnerHeartbeatAsyncin 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
public Future<SetStatusResult> setStatusAsync(SetStatusRequest request)
Description copied from interface:DataPipelineAsyncRequests 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
FINISHEDpipelines and attempting to do so returnsInvalidRequestException.- Specified by:
setStatusAsyncin 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:DataPipelineAsyncRequests 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
FINISHEDpipelines and attempting to do so returnsInvalidRequestException.- Specified by:
setStatusAsyncin 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
public Future<SetTaskStatusResult> setTaskStatusAsync(SetTaskStatusRequest request)
Description copied from interface:DataPipelineAsyncTask runners call
SetTaskStatusto 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 callSetTaskStatusfor tasks that are canceled by the web service during a call to ReportTaskProgress.- Specified by:
setTaskStatusAsyncin 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:DataPipelineAsyncTask runners call
SetTaskStatusto 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 callSetTaskStatusfor tasks that are canceled by the web service during a call to ReportTaskProgress.- Specified by:
setTaskStatusAsyncin 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:DataPipelineAsyncValidates the specified pipeline definition to ensure that it is well formed and can be run without error.
- Specified by:
validatePipelineDefinitionAsyncin 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:DataPipelineAsyncValidates the specified pipeline definition to ensure that it is well formed and can be run without error.
- Specified by:
validatePipelineDefinitionAsyncin 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.
-
-