Class DataPipelineAsyncClient

All Implemented Interfaces:
DataPipeline, DataPipelineAsync

@ThreadSafe public class DataPipelineAsyncClient extends DataPipelineClient implements DataPipelineAsync
Interface for accessing AWS Data Pipeline asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an 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.

  • Constructor Details

    • DataPipelineAsyncClient

      public DataPipelineAsyncClient()
      Constructs a new asynchronous client to invoke service methods on AWS Data Pipeline. A credentials provider chain will be used that searches for credentials in this order:
      • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
      • Java System Properties - aws.accessKeyId and aws.secretKey
      • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
      • Instance profile credentials delivered through the Amazon EC2 metadata service

      Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

      See Also:
    • DataPipelineAsyncClient

      public DataPipelineAsyncClient(ClientConfiguration clientConfiguration)
      Constructs a new asynchronous client to invoke service methods on AWS Data Pipeline. A credentials provider chain will be used that searches for credentials in this order:
      • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
      • Java System Properties - aws.accessKeyId and aws.secretKey
      • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
      • Instance profile credentials delivered through the Amazon EC2 metadata service

      Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

      Parameters:
      clientConfiguration - The client configuration options controlling how this client connects to AWS Data Pipeline (ex: proxy settings, retry counts, etc).
      See Also:
    • DataPipelineAsyncClient

      public DataPipelineAsyncClient(AWSCredentials awsCredentials)
      Constructs a new asynchronous client to invoke service methods on AWS Data Pipeline using the specified AWS account credentials.

      Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

      Parameters:
      awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      See Also:
    • DataPipelineAsyncClient

      public DataPipelineAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
      Constructs a new asynchronous client to invoke service methods on AWS Data Pipeline using the specified AWS account credentials and executor service. Default client settings will be used.
      Parameters:
      awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      executorService - The executor service by which all asynchronous requests will be executed.
    • DataPipelineAsyncClient

      public DataPipelineAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
      Constructs a new asynchronous client to invoke service methods on AWS Data Pipeline using the specified AWS account credentials, executor service, and client configuration options.
      Parameters:
      awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
      executorService - The executor service by which all asynchronous requests will be executed.
    • DataPipelineAsyncClient

      public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
      Constructs a new asynchronous client to invoke service methods on AWS Data Pipeline using the specified AWS account credentials provider. Default client settings will be used.

      Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

      Parameters:
      awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      See Also:
    • DataPipelineAsyncClient

      public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
      Constructs a new asynchronous client to invoke service methods on AWS Data Pipeline using the provided AWS account credentials provider and client configuration options.

      Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

      Parameters:
      awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
      See Also:
    • DataPipelineAsyncClient

      public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
      Constructs a new asynchronous client to invoke service methods on AWS Data Pipeline using the specified AWS account credentials provider and executor service. Default client settings will be used.
      Parameters:
      awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      executorService - The executor service by which all asynchronous requests will be executed.
    • DataPipelineAsyncClient

      public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
      Constructs a new asynchronous client to invoke service methods on AWS Data Pipeline using the specified AWS account credentials provider, executor service, and client configuration options.
      Parameters:
      awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
      executorService - The executor service by which all asynchronous requests will be executed.
  • Method Details

    • getExecutorService

      public ExecutorService getExecutorService()
      Returns the executor service used by this client to execute async requests.
      Returns:
      The executor service used by this client to execute async requests.
    • activatePipelineAsync

      public Future<ActivatePipelineResult> activatePipelineAsync(ActivatePipelineRequest request)
      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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for ActivatePipeline.
      Returns:
      A Java Future containing the result of the ActivatePipeline operation returned by the service.
    • 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 interface DataPipelineAsync
      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: DataPipelineAsync

      Adds or modifies tags for the specified pipeline.

      Specified by:
      addTagsAsync in interface DataPipelineAsync
      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 interface DataPipelineAsync
      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: DataPipelineAsync

      Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

      Specified by:
      createPipelineAsync in interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for CreatePipeline.
      Returns:
      A Java Future containing the result of the CreatePipeline 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 interface DataPipelineAsync
      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: 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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for DeactivatePipeline.
      Returns:
      A Java Future containing the result of the DeactivatePipeline 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 interface DataPipelineAsync
      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: 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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for DeletePipeline.
      Returns:
      A Java Future containing the result of the DeletePipeline 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 interface DataPipelineAsync
      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: 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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for DescribeObjects.
      Returns:
      A Java Future containing the result of the DescribeObjects 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 interface DataPipelineAsync
      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: 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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for DescribePipelines.
      Returns:
      A Java Future containing the result of the DescribePipelines 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 interface DataPipelineAsync
      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: 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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for EvaluateExpression.
      Returns:
      A Java Future containing the result of the EvaluateExpression 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 interface DataPipelineAsync
      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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for GetPipelineDefinition.
      Returns:
      A Java Future containing the result of the GetPipelineDefinition operation returned by the service.
    • getPipelineDefinitionAsync

      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 interface DataPipelineAsync
      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: DataPipelineAsync

      Lists the pipeline identifiers for all active pipelines that you have permission to access.

      Specified by:
      listPipelinesAsync in interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for ListPipelines.
      Returns:
      A Java Future containing the result of the ListPipelines 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 interface DataPipelineAsync
      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:
      listPipelinesAsync in interface DataPipelineAsync
      See Also:
    • listPipelinesAsync

      Simplified method form for invoking the ListPipelines operation with an AsyncHandler.
      Specified by:
      listPipelinesAsync in interface DataPipelineAsync
      See Also:
    • pollForTaskAsync

      public Future<PollForTaskResult> pollForTaskAsync(PollForTaskRequest request)
      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 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.

      Specified by:
      pollForTaskAsync in interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for PollForTask.
      Returns:
      A Java Future containing the result of the PollForTask operation returned by the service.
    • 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 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.

      Specified by:
      pollForTaskAsync in interface DataPipelineAsync
      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.

      1. An object is missing a name or identifier field.
      2. A string or reference field is empty.
      3. The number of objects in the pipeline exceeds the maximum allowed objects.
      4. 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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for PutPipelineDefinition.
      Returns:
      A Java Future containing the result of the PutPipelineDefinition operation returned by the service.
    • putPipelineDefinitionAsync

      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.

      1. An object is missing a name or identifier field.
      2. A string or reference field is empty.
      3. The number of objects in the pipeline exceeds the maximum allowed objects.
      4. 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 interface DataPipelineAsync
      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: DataPipelineAsync

      Queries the specified pipeline for the names of objects that match the specified set of conditions.

      Specified by:
      queryObjectsAsync in interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for QueryObjects.
      Returns:
      A Java Future containing the result of the QueryObjects 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 interface DataPipelineAsync
      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: DataPipelineAsync

      Removes existing tags from the specified pipeline.

      Specified by:
      removeTagsAsync in interface DataPipelineAsync
      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 interface DataPipelineAsync
      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: 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 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.

      Specified by:
      reportTaskProgressAsync in interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for ReportTaskProgress.
      Returns:
      A Java Future containing the result of the ReportTaskProgress 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 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.

      Specified by:
      reportTaskProgressAsync in interface DataPipelineAsync
      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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for ReportTaskRunnerHeartbeat.
      Returns:
      A Java Future containing the result of the ReportTaskRunnerHeartbeat operation returned by the service.
    • reportTaskRunnerHeartbeatAsync

      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 interface DataPipelineAsync
      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: 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 returns InvalidRequestException.

      Specified by:
      setStatusAsync in interface DataPipelineAsync
      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 returns InvalidRequestException.

      Specified by:
      setStatusAsync in interface DataPipelineAsync
      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: 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 call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

      Specified by:
      setTaskStatusAsync in interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for SetTaskStatus.
      Returns:
      A Java Future containing the result of the SetTaskStatus 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 call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

      Specified by:
      setTaskStatusAsync in interface DataPipelineAsync
      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 interface DataPipelineAsync
      Parameters:
      request - Contains the parameters for ValidatePipelineDefinition.
      Returns:
      A Java Future containing the result of the ValidatePipelineDefinition operation returned by the service.
    • validatePipelineDefinitionAsync

      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 interface DataPipelineAsync
      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.
    • shutdown

      public void shutdown()
      Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
      Specified by:
      shutdown in interface DataPipeline
      Overrides:
      shutdown in class AmazonWebServiceClient