com.amazonaws.services.datapipeline.DataPipelineAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-datapipeline Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.datapipeline;
import com.amazonaws.services.datapipeline.model.*;
/**
* Interface for accessing AWS Data Pipeline asynchronously. Each asynchronous
* method will return a Java Future object representing the asynchronous
* operation; overloads which accept an {@code AsyncHandler} can be used to
* receive notification when an asynchronous operation completes.
*
*
* 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.
*
*/
public interface DataPipelineAsync extends DataPipeline {
/**
*
* 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.
*
*
* @param activatePipelineRequest
* Contains the parameters for ActivatePipeline.
* @return A Java Future containing the result of the ActivatePipeline
* operation returned by the service.
* @sample DataPipelineAsync.ActivatePipeline
*/
java.util.concurrent.Future activatePipelineAsync(
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.
*
*
* @param activatePipelineRequest
* Contains the parameters for ActivatePipeline.
* @param 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.
* @return A Java Future containing the result of the ActivatePipeline
* operation returned by the service.
* @sample DataPipelineAsyncHandler.ActivatePipeline
*/
java.util.concurrent.Future activatePipelineAsync(
ActivatePipelineRequest activatePipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds or modifies tags for the specified pipeline.
*
*
* @param addTagsRequest
* Contains the parameters for AddTags.
* @return A Java Future containing the result of the AddTags operation
* returned by the service.
* @sample DataPipelineAsync.AddTags
*/
java.util.concurrent.Future addTagsAsync(
AddTagsRequest addTagsRequest);
/**
*
* Adds or modifies tags for the specified pipeline.
*
*
* @param addTagsRequest
* Contains the parameters for AddTags.
* @param 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.
* @return A Java Future containing the result of the AddTags operation
* returned by the service.
* @sample DataPipelineAsyncHandler.AddTags
*/
java.util.concurrent.Future addTagsAsync(
AddTagsRequest addTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a new, empty pipeline. Use PutPipelineDefinition to
* populate the pipeline.
*
*
* @param createPipelineRequest
* Contains the parameters for CreatePipeline.
* @return A Java Future containing the result of the CreatePipeline
* operation returned by the service.
* @sample DataPipelineAsync.CreatePipeline
*/
java.util.concurrent.Future createPipelineAsync(
CreatePipelineRequest createPipelineRequest);
/**
*
* Creates a new, empty pipeline. Use PutPipelineDefinition to
* populate the pipeline.
*
*
* @param createPipelineRequest
* Contains the parameters for CreatePipeline.
* @param 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.
* @return A Java Future containing the result of the CreatePipeline
* operation returned by the service.
* @sample DataPipelineAsyncHandler.CreatePipeline
*/
java.util.concurrent.Future createPipelineAsync(
CreatePipelineRequest createPipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deactivatePipelineRequest
* Contains the parameters for DeactivatePipeline.
* @return A Java Future containing the result of the DeactivatePipeline
* operation returned by the service.
* @sample DataPipelineAsync.DeactivatePipeline
*/
java.util.concurrent.Future deactivatePipelineAsync(
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.
*
*
* @param deactivatePipelineRequest
* Contains the parameters for DeactivatePipeline.
* @param 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.
* @return A Java Future containing the result of the DeactivatePipeline
* operation returned by the service.
* @sample DataPipelineAsyncHandler.DeactivatePipeline
*/
java.util.concurrent.Future deactivatePipelineAsync(
DeactivatePipelineRequest deactivatePipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deletePipelineRequest
* Contains the parameters for DeletePipeline.
* @return A Java Future containing the result of the DeletePipeline
* operation returned by the service.
* @sample DataPipelineAsync.DeletePipeline
*/
java.util.concurrent.Future deletePipelineAsync(
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.
*
*
* @param deletePipelineRequest
* Contains the parameters for DeletePipeline.
* @param 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.
* @return A Java Future containing the result of the DeletePipeline
* operation returned by the service.
* @sample DataPipelineAsyncHandler.DeletePipeline
*/
java.util.concurrent.Future deletePipelineAsync(
DeletePipelineRequest deletePipelineRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeObjectsRequest
* Contains the parameters for DescribeObjects.
* @return A Java Future containing the result of the DescribeObjects
* operation returned by the service.
* @sample DataPipelineAsync.DescribeObjects
*/
java.util.concurrent.Future describeObjectsAsync(
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.
*
*
* @param describeObjectsRequest
* Contains the parameters for DescribeObjects.
* @param 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.
* @return A Java Future containing the result of the DescribeObjects
* operation returned by the service.
* @sample DataPipelineAsyncHandler.DescribeObjects
*/
java.util.concurrent.Future describeObjectsAsync(
DescribeObjectsRequest describeObjectsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describePipelinesRequest
* Contains the parameters for DescribePipelines.
* @return A Java Future containing the result of the DescribePipelines
* operation returned by the service.
* @sample DataPipelineAsync.DescribePipelines
*/
java.util.concurrent.Future describePipelinesAsync(
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.
*
*
* @param describePipelinesRequest
* Contains the parameters for DescribePipelines.
* @param 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.
* @return A Java Future containing the result of the DescribePipelines
* operation returned by the service.
* @sample DataPipelineAsyncHandler.DescribePipelines
*/
java.util.concurrent.Future describePipelinesAsync(
DescribePipelinesRequest describePipelinesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param evaluateExpressionRequest
* Contains the parameters for EvaluateExpression.
* @return A Java Future containing the result of the EvaluateExpression
* operation returned by the service.
* @sample DataPipelineAsync.EvaluateExpression
*/
java.util.concurrent.Future evaluateExpressionAsync(
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.
*
*
* @param evaluateExpressionRequest
* Contains the parameters for EvaluateExpression.
* @param 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.
* @return A Java Future containing the result of the EvaluateExpression
* operation returned by the service.
* @sample DataPipelineAsyncHandler.EvaluateExpression
*/
java.util.concurrent.Future evaluateExpressionAsync(
EvaluateExpressionRequest evaluateExpressionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the definition of the specified pipeline. You can call
* GetPipelineDefinition to retrieve the pipeline definition
* that you provided using PutPipelineDefinition.
*
*
* @param getPipelineDefinitionRequest
* Contains the parameters for GetPipelineDefinition.
* @return A Java Future containing the result of the GetPipelineDefinition
* operation returned by the service.
* @sample DataPipelineAsync.GetPipelineDefinition
*/
java.util.concurrent.Future getPipelineDefinitionAsync(
GetPipelineDefinitionRequest getPipelineDefinitionRequest);
/**
*
* Gets the definition of the specified pipeline. You can call
* GetPipelineDefinition to retrieve the pipeline definition
* that you provided using PutPipelineDefinition.
*
*
* @param getPipelineDefinitionRequest
* Contains the parameters for GetPipelineDefinition.
* @param 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.
* @return A Java Future containing the result of the GetPipelineDefinition
* operation returned by the service.
* @sample DataPipelineAsyncHandler.GetPipelineDefinition
*/
java.util.concurrent.Future getPipelineDefinitionAsync(
GetPipelineDefinitionRequest getPipelineDefinitionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the pipeline identifiers for all active pipelines that you have
* permission to access.
*
*
* @param listPipelinesRequest
* Contains the parameters for ListPipelines.
* @return A Java Future containing the result of the ListPipelines
* operation returned by the service.
* @sample DataPipelineAsync.ListPipelines
*/
java.util.concurrent.Future listPipelinesAsync(
ListPipelinesRequest listPipelinesRequest);
/**
*
* Lists the pipeline identifiers for all active pipelines that you have
* permission to access.
*
*
* @param listPipelinesRequest
* Contains the parameters for ListPipelines.
* @param 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.
* @return A Java Future containing the result of the ListPipelines
* operation returned by the service.
* @sample DataPipelineAsyncHandler.ListPipelines
*/
java.util.concurrent.Future listPipelinesAsync(
ListPipelinesRequest listPipelinesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListPipelines operation.
*
* @see #listPipelinesAsync(ListPipelinesRequest)
*/
java.util.concurrent.Future listPipelinesAsync();
/**
* Simplified method form for invoking the ListPipelines operation with an
* AsyncHandler.
*
* @see #listPipelinesAsync(ListPipelinesRequest,
* com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listPipelinesAsync(
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param pollForTaskRequest
* Contains the parameters for PollForTask.
* @return A Java Future containing the result of the PollForTask operation
* returned by the service.
* @sample DataPipelineAsync.PollForTask
*/
java.util.concurrent.Future pollForTaskAsync(
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.
*
*
* @param pollForTaskRequest
* Contains the parameters for PollForTask.
* @param 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.
* @return A Java Future containing the result of the PollForTask operation
* returned by the service.
* @sample DataPipelineAsyncHandler.PollForTask
*/
java.util.concurrent.Future pollForTaskAsync(
PollForTaskRequest pollForTaskRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param putPipelineDefinitionRequest
* Contains the parameters for PutPipelineDefinition.
* @return A Java Future containing the result of the PutPipelineDefinition
* operation returned by the service.
* @sample DataPipelineAsync.PutPipelineDefinition
*/
java.util.concurrent.Future putPipelineDefinitionAsync(
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.
*
*
* - 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.
*
*
* @param putPipelineDefinitionRequest
* Contains the parameters for PutPipelineDefinition.
* @param 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.
* @return A Java Future containing the result of the PutPipelineDefinition
* operation returned by the service.
* @sample DataPipelineAsyncHandler.PutPipelineDefinition
*/
java.util.concurrent.Future putPipelineDefinitionAsync(
PutPipelineDefinitionRequest putPipelineDefinitionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Queries the specified pipeline for the names of objects that match the
* specified set of conditions.
*
*
* @param queryObjectsRequest
* Contains the parameters for QueryObjects.
* @return A Java Future containing the result of the QueryObjects operation
* returned by the service.
* @sample DataPipelineAsync.QueryObjects
*/
java.util.concurrent.Future queryObjectsAsync(
QueryObjectsRequest queryObjectsRequest);
/**
*
* Queries the specified pipeline for the names of objects that match the
* specified set of conditions.
*
*
* @param queryObjectsRequest
* Contains the parameters for QueryObjects.
* @param 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.
* @return A Java Future containing the result of the QueryObjects operation
* returned by the service.
* @sample DataPipelineAsyncHandler.QueryObjects
*/
java.util.concurrent.Future queryObjectsAsync(
QueryObjectsRequest queryObjectsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes existing tags from the specified pipeline.
*
*
* @param removeTagsRequest
* Contains the parameters for RemoveTags.
* @return A Java Future containing the result of the RemoveTags operation
* returned by the service.
* @sample DataPipelineAsync.RemoveTags
*/
java.util.concurrent.Future removeTagsAsync(
RemoveTagsRequest removeTagsRequest);
/**
*
* Removes existing tags from the specified pipeline.
*
*
* @param removeTagsRequest
* Contains the parameters for RemoveTags.
* @param 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.
* @return A Java Future containing the result of the RemoveTags operation
* returned by the service.
* @sample DataPipelineAsyncHandler.RemoveTags
*/
java.util.concurrent.Future removeTagsAsync(
RemoveTagsRequest removeTagsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param reportTaskProgressRequest
* Contains the parameters for ReportTaskProgress.
* @return A Java Future containing the result of the ReportTaskProgress
* operation returned by the service.
* @sample DataPipelineAsync.ReportTaskProgress
*/
java.util.concurrent.Future reportTaskProgressAsync(
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.
*
*
* @param reportTaskProgressRequest
* Contains the parameters for ReportTaskProgress.
* @param 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.
* @return A Java Future containing the result of the ReportTaskProgress
* operation returned by the service.
* @sample DataPipelineAsyncHandler.ReportTaskProgress
*/
java.util.concurrent.Future reportTaskProgressAsync(
ReportTaskProgressRequest reportTaskProgressRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param reportTaskRunnerHeartbeatRequest
* Contains the parameters for ReportTaskRunnerHeartbeat.
* @return A Java Future containing the result of the
* ReportTaskRunnerHeartbeat operation returned by the service.
* @sample DataPipelineAsync.ReportTaskRunnerHeartbeat
*/
java.util.concurrent.Future reportTaskRunnerHeartbeatAsync(
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.
*
*
* @param reportTaskRunnerHeartbeatRequest
* Contains the parameters for ReportTaskRunnerHeartbeat.
* @param 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.
* @return A Java Future containing the result of the
* ReportTaskRunnerHeartbeat operation returned by the service.
* @sample DataPipelineAsyncHandler.ReportTaskRunnerHeartbeat
*/
java.util.concurrent.Future reportTaskRunnerHeartbeatAsync(
ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param setStatusRequest
* Contains the parameters for SetStatus.
* @return A Java Future containing the result of the SetStatus operation
* returned by the service.
* @sample DataPipelineAsync.SetStatus
*/
java.util.concurrent.Future setStatusAsync(
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.
*
*
* @param setStatusRequest
* Contains the parameters for SetStatus.
* @param 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.
* @return A Java Future containing the result of the SetStatus operation
* returned by the service.
* @sample DataPipelineAsyncHandler.SetStatus
*/
java.util.concurrent.Future setStatusAsync(
SetStatusRequest setStatusRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param setTaskStatusRequest
* Contains the parameters for SetTaskStatus.
* @return A Java Future containing the result of the SetTaskStatus
* operation returned by the service.
* @sample DataPipelineAsync.SetTaskStatus
*/
java.util.concurrent.Future setTaskStatusAsync(
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.
*
*
* @param setTaskStatusRequest
* Contains the parameters for SetTaskStatus.
* @param 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.
* @return A Java Future containing the result of the SetTaskStatus
* operation returned by the service.
* @sample DataPipelineAsyncHandler.SetTaskStatus
*/
java.util.concurrent.Future setTaskStatusAsync(
SetTaskStatusRequest setTaskStatusRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Validates the specified pipeline definition to ensure that it is well
* formed and can be run without error.
*
*
* @param validatePipelineDefinitionRequest
* Contains the parameters for ValidatePipelineDefinition.
* @return A Java Future containing the result of the
* ValidatePipelineDefinition operation returned by the service.
* @sample DataPipelineAsync.ValidatePipelineDefinition
*/
java.util.concurrent.Future validatePipelineDefinitionAsync(
ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest);
/**
*
* Validates the specified pipeline definition to ensure that it is well
* formed and can be run without error.
*
*
* @param validatePipelineDefinitionRequest
* Contains the parameters for ValidatePipelineDefinition.
* @param 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.
* @return A Java Future containing the result of the
* ValidatePipelineDefinition operation returned by the service.
* @sample DataPipelineAsyncHandler.ValidatePipelineDefinition
*/
java.util.concurrent.Future validatePipelineDefinitionAsync(
ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}