DataPipelineAsyncClient (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.datapipeline
Class DataPipelineAsyncClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.datapipeline.DataPipelineClient
          com.amazonaws.services.datapipeline.DataPipelineAsyncClient

All Implemented Interfaces:: DataPipeline, DataPipelineAsync

public class DataPipelineAsyncClient
extends DataPipelineClient
implements DataPipelineAsync
extends DataPipelineClient
implements DataPipelineAsync

Asynchronous client for accessing DataPipeline. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread.

This is the AWS Data Pipeline API Reference . This guide provides descriptions and samples of the AWS Data Pipeline API.

AWS Data Pipeline is a web service that 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 your application can focus on processing the data.

The AWS Data Pipeline API implements two main sets of functionality. The first set of actions configure the pipeline in the web service. You call these actions to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data.

The second set of actions are used by a task runner application that calls the AWS Data Pipeline API 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.

AWS Data Pipeline provides an open-source 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.

The AWS Data Pipeline API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process . In the code examples in this reference, the Signature Version 4 Request parameters are represented as AuthParams.

Constructor Summary
`DataPipelineAsyncClient()` Constructs a new asynchronous client to invoke service methods on DataPipeline.
`DataPipelineAsyncClient(AWSCredentials awsCredentials)` Constructs a new asynchronous client to invoke service methods on DataPipeline using the specified AWS account credentials.
`DataPipelineAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on DataPipeline using the specified AWS account credentials, executor service, and client configuration options.
`DataPipelineAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on DataPipeline using the specified AWS account credentials and executor service.
`DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new asynchronous client to invoke service methods on DataPipeline using the specified AWS account credentials provider.
`DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new asynchronous client to invoke service methods on DataPipeline using the specified AWS account credentials provider and client configuration options.
`DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on DataPipeline using the specified AWS account credentials provider, executor service, and client configuration options.
`DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on DataPipeline using the specified AWS account credentials provider and executor service.
`DataPipelineAsyncClient(ClientConfiguration clientConfiguration)` Constructs a new asynchronous client to invoke service methods on DataPipeline.

Method Summary
`Future<ActivatePipelineResult>`	`activatePipelineAsync(ActivatePipelineRequest activatePipelineRequest)` Validates a pipeline and initiates processing.
`Future<ActivatePipelineResult>`	`activatePipelineAsync(ActivatePipelineRequest activatePipelineRequest, AsyncHandler<ActivatePipelineRequest,ActivatePipelineResult> asyncHandler)` Validates a pipeline and initiates processing.
`Future<CreatePipelineResult>`	`createPipelineAsync(CreatePipelineRequest createPipelineRequest)` Creates a new empty pipeline.
`Future<CreatePipelineResult>`	`createPipelineAsync(CreatePipelineRequest createPipelineRequest, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)` Creates a new empty pipeline.
`Future<Void>`	`deletePipelineAsync(DeletePipelineRequest deletePipelineRequest)` Permanently deletes a pipeline, its pipeline definition and its run history.
`Future<Void>`	`deletePipelineAsync(DeletePipelineRequest deletePipelineRequest, AsyncHandler<DeletePipelineRequest,Void> asyncHandler)` Permanently deletes a pipeline, its pipeline definition and its run history.
`Future<DescribeObjectsResult>`	`describeObjectsAsync(DescribeObjectsRequest describeObjectsRequest)` Returns the object definitions for a set of objects associated with the pipeline.
`Future<DescribeObjectsResult>`	`describeObjectsAsync(DescribeObjectsRequest describeObjectsRequest, AsyncHandler<DescribeObjectsRequest,DescribeObjectsResult> asyncHandler)` Returns the object definitions for a set of objects associated with the pipeline.
`Future<DescribePipelinesResult>`	`describePipelinesAsync(DescribePipelinesRequest describePipelinesRequest)` Retrieve metadata about one or more pipelines.
`Future<DescribePipelinesResult>`	`describePipelinesAsync(DescribePipelinesRequest describePipelinesRequest, AsyncHandler<DescribePipelinesRequest,DescribePipelinesResult> asyncHandler)` Retrieve metadata about one or more pipelines.
`Future<EvaluateExpressionResult>`	`evaluateExpressionAsync(EvaluateExpressionRequest evaluateExpressionRequest)` Evaluates a string in the context of a specified object.
`Future<EvaluateExpressionResult>`	`evaluateExpressionAsync(EvaluateExpressionRequest evaluateExpressionRequest, AsyncHandler<EvaluateExpressionRequest,EvaluateExpressionResult> asyncHandler)` Evaluates a string in the context of a specified object.
`ExecutorService`	`getExecutorService()` Returns the executor service used by this async client to execute requests.
`Future<GetPipelineDefinitionResult>`	`getPipelineDefinitionAsync(GetPipelineDefinitionRequest getPipelineDefinitionRequest)` Returns the definition of the specified pipeline.
`Future<GetPipelineDefinitionResult>`	`getPipelineDefinitionAsync(GetPipelineDefinitionRequest getPipelineDefinitionRequest, AsyncHandler<GetPipelineDefinitionRequest,GetPipelineDefinitionResult> asyncHandler)` Returns the definition of the specified pipeline.
`Future<ListPipelinesResult>`	`listPipelinesAsync(ListPipelinesRequest listPipelinesRequest)` Returns a list of pipeline identifiers for all active pipelines.
`Future<ListPipelinesResult>`	`listPipelinesAsync(ListPipelinesRequest listPipelinesRequest, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)` Returns a list of pipeline identifiers for all active pipelines.
`Future<PollForTaskResult>`	`pollForTaskAsync(PollForTaskRequest pollForTaskRequest)` Task runners call this action to receive a task to perform from AWS Data Pipeline.
`Future<PollForTaskResult>`	`pollForTaskAsync(PollForTaskRequest pollForTaskRequest, AsyncHandler<PollForTaskRequest,PollForTaskResult> asyncHandler)` Task runners call this action to receive a task to perform from AWS Data Pipeline.
`Future<PutPipelineDefinitionResult>`	`putPipelineDefinitionAsync(PutPipelineDefinitionRequest putPipelineDefinitionRequest)` Adds tasks, schedules, and preconditions that control the behavior of the pipeline.
`Future<PutPipelineDefinitionResult>`	`putPipelineDefinitionAsync(PutPipelineDefinitionRequest putPipelineDefinitionRequest, AsyncHandler<PutPipelineDefinitionRequest,PutPipelineDefinitionResult> asyncHandler)` Adds tasks, schedules, and preconditions that control the behavior of the pipeline.
`Future<QueryObjectsResult>`	`queryObjectsAsync(QueryObjectsRequest queryObjectsRequest)` Queries a pipeline for the names of objects that match a specified set of conditions.
`Future<QueryObjectsResult>`	`queryObjectsAsync(QueryObjectsRequest queryObjectsRequest, AsyncHandler<QueryObjectsRequest,QueryObjectsResult> asyncHandler)` Queries a pipeline for the names of objects that match a specified set of conditions.
`Future<ReportTaskProgressResult>`	`reportTaskProgressAsync(ReportTaskProgressRequest reportTaskProgressRequest)` Updates the AWS Data Pipeline service on the progress of the calling task runner.
`Future<ReportTaskProgressResult>`	`reportTaskProgressAsync(ReportTaskProgressRequest reportTaskProgressRequest, AsyncHandler<ReportTaskProgressRequest,ReportTaskProgressResult> asyncHandler)` Updates the AWS Data Pipeline service on the progress of the calling task runner.
`Future<ReportTaskRunnerHeartbeatResult>`	`reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest)` Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational.
`Future<ReportTaskRunnerHeartbeatResult>`	`reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest, AsyncHandler<ReportTaskRunnerHeartbeatRequest,ReportTaskRunnerHeartbeatResult> asyncHandler)` Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational.
`Future<Void>`	`setStatusAsync(SetStatusRequest setStatusRequest)` Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline.
`Future<Void>`	`setStatusAsync(SetStatusRequest setStatusRequest, AsyncHandler<SetStatusRequest,Void> asyncHandler)` Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline.
`Future<SetTaskStatusResult>`	`setTaskStatusAsync(SetTaskStatusRequest setTaskStatusRequest)` Notifies AWS Data Pipeline that a task is completed and provides information about the final status.
`Future<SetTaskStatusResult>`	`setTaskStatusAsync(SetTaskStatusRequest setTaskStatusRequest, AsyncHandler<SetTaskStatusRequest,SetTaskStatusResult> asyncHandler)` Notifies AWS Data Pipeline that a task is completed and provides information about the final status.
`void`	`shutdown()` Shuts down the client, releasing all managed resources.
`Future<ValidatePipelineDefinitionResult>`	`validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest)` Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error.
`Future<ValidatePipelineDefinitionResult>`	`validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest, AsyncHandler<ValidatePipelineDefinitionRequest,ValidatePipelineDefinitionResult> asyncHandler)` Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error.

Methods inherited from class com.amazonaws.services.datapipeline.DataPipelineClient
`activatePipeline, createPipeline, deletePipeline, describeObjects, describePipelines, evaluateExpression, getCachedResponseMetadata, getPipelineDefinition, listPipelines, listPipelines, pollForTask, putPipelineDefinition, queryObjects, reportTaskProgress, reportTaskRunnerHeartbeat, setEndpoint, setStatus, setTaskStatus, validatePipelineDefinition`

Methods inherited from class com.amazonaws.AmazonWebServiceClient
`addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, withTimeOffset`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.amazonaws.services.datapipeline.DataPipeline
`activatePipeline, createPipeline, deletePipeline, describeObjects, describePipelines, evaluateExpression, getCachedResponseMetadata, getPipelineDefinition, listPipelines, listPipelines, pollForTask, putPipelineDefinition, queryObjects, reportTaskProgress, reportTaskRunnerHeartbeat, setEndpoint, setRegion, setStatus, setTaskStatus, validatePipelineDefinition`

Constructor Detail

DataPipelineAsyncClient

public DataPipelineAsyncClient()

Constructs a new asynchronous client to invoke service methods on DataPipeline. 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
Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:: DefaultAWSCredentialsProvider

DataPipelineAsyncClient

public DataPipelineAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on DataPipeline. 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
Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:: clientConfiguration - The client configuration options controlling how this client connects to DataPipeline (ex: proxy settings, retry counts, etc.).
See Also:: DefaultAWSCredentialsProvider

DataPipelineAsyncClient

public DataPipelineAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on DataPipeline using the specified AWS account credentials. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.