@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DataPipelineAsyncClient extends DataPipelineClient implements DataPipelineAsync
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.
LOGGING_AWS_REQUEST_METRIC ENDPOINT_PREFIX | Constructor and Description |
|---|
DataPipelineAsyncClient ()
Deprecated.
|
DataPipelineAsyncClient (AWSCredentials awsCredentials)
Deprecated.
|
DataPipelineAsyncClient (AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
DataPipelineAsyncClient (AWSCredentials awsCredentials,
ExecutorService executorService)
|
DataPipelineAsyncClient (AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
DataPipelineAsyncClient (AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
DataPipelineAsyncClient (AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
DataPipelineAsyncClient (AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
DataPipelineAsyncClient (ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
Future<ActivatePipelineResult> |
activatePipelineAsync (ActivatePipelineRequest request)
Validates the specified pipeline and starts processing pipeline tasks.
|
Future<ActivatePipelineResult> |
activatePipelineAsync (ActivatePipelineRequest request,
AsyncHandler<ActivatePipelineRequest,ActivatePipelineResult> asyncHandler)
Validates the specified pipeline and starts processing pipeline tasks.
|
Future<AddTagsResult> |
addTagsAsync (AddTagsRequest request)
Adds or modifies tags for the specified pipeline.
|
Future<AddTagsResult> |
addTagsAsync (AddTagsRequest request,
AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)
Adds or modifies tags for the specified pipeline.
|
static DataPipelineAsyncClientBuilder |
asyncBuilder () |
Future<CreatePipelineResult> |
createPipelineAsync (CreatePipelineRequest request)
Creates a new, empty pipeline.
|
Future<CreatePipelineResult> |
createPipelineAsync (CreatePipelineRequest request,
AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
Creates a new, empty pipeline.
|
Future<DeactivatePipelineResult> |
deactivatePipelineAsync (DeactivatePipelineRequest request)
Deactivates the specified running pipeline.
|
Future<DeactivatePipelineResult> |
deactivatePipelineAsync (DeactivatePipelineRequest request,
AsyncHandler<DeactivatePipelineRequest,DeactivatePipelineResult> asyncHandler)
Deactivates the specified running pipeline.
|
Future<DeletePipelineResult> |
deletePipelineAsync (DeletePipelineRequest request)
Deletes a pipeline, its pipeline definition, and its run history.
|
Future<DeletePipelineResult> |
deletePipelineAsync (DeletePipelineRequest request,
AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
Deletes a pipeline, its pipeline definition, and its run history.
|
Future<DescribeObjectsResult> |
describeObjectsAsync (DescribeObjectsRequest request)
Gets the object definitions for a set of objects associated with the pipeline.
|
Future<DescribeObjectsResult> |
describeObjectsAsync (DescribeObjectsRequest request,
AsyncHandler<DescribeObjectsRequest,DescribeObjectsResult> asyncHandler)
Gets the object definitions for a set of objects associated with the pipeline.
|
Future<DescribePipelinesResult> |
describePipelinesAsync (DescribePipelinesRequest request)
Retrieves metadata about one or more pipelines.
|
Future<DescribePipelinesResult> |
describePipelinesAsync (DescribePipelinesRequest request,
AsyncHandler<DescribePipelinesRequest,DescribePipelinesResult> asyncHandler)
Retrieves metadata about one or more pipelines.
|
Future<EvaluateExpressionResult> |
evaluateExpressionAsync (EvaluateExpressionRequest request)
Task runners call
EvaluateExpression to evaluate a string in the context of the specified object. |
Future<EvaluateExpressionResult> |
evaluateExpressionAsync (EvaluateExpressionRequest request,
AsyncHandler<EvaluateExpressionRequest,EvaluateExpressionResult> asyncHandler)
Task runners call
EvaluateExpression to evaluate a string in the context of the specified object. |
ExecutorService |
getExecutorService ()
Returns the executor service used by this client to execute async requests.
|
Future<GetPipelineDefinitionResult> |
getPipelineDefinitionAsync (GetPipelineDefinitionRequest request)
Gets the definition of the specified pipeline.
|
Future<GetPipelineDefinitionResult> |
getPipelineDefinitionAsync (GetPipelineDefinitionRequest request,
AsyncHandler<GetPipelineDefinitionRequest,GetPipelineDefinitionResult> asyncHandler)
Gets the definition of the specified pipeline.
|
Future<ListPipelinesResult> |
listPipelinesAsync ()
Simplified method form for invoking the ListPipelines operation.
|
Future<ListPipelinesResult> |
listPipelinesAsync (AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
Simplified method form for invoking the ListPipelines operation with an AsyncHandler.
|
Future<ListPipelinesResult> |
listPipelinesAsync (ListPipelinesRequest request)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
Future<ListPipelinesResult> |
listPipelinesAsync (ListPipelinesRequest request,
AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
Lists the pipeline identifiers for all active pipelines that you have permission to access.
|
Future<PollForTaskResult> |
pollForTaskAsync (PollForTaskRequest request)
Task runners call
PollForTask to receive a task to perform from AWS Data Pipeline. |
Future<PollForTaskResult> |
pollForTaskAsync (PollForTaskRequest request,
AsyncHandler<PollForTaskRequest,PollForTaskResult> asyncHandler)
Task runners call
PollForTask to receive a task to perform from AWS Data Pipeline. |
Future<PutPipelineDefinitionResult> |
putPipelineDefinitionAsync (PutPipelineDefinitionRequest request)
Adds tasks, schedules, and preconditions to the specified pipeline.
|
Future<PutPipelineDefinitionResult> |
putPipelineDefinitionAsync (PutPipelineDefinitionRequest request,
AsyncHandler<PutPipelineDefinitionRequest,PutPipelineDefinitionResult> asyncHandler)
Adds tasks, schedules, and preconditions to the specified pipeline.
|
Future<QueryObjectsResult> |
queryObjectsAsync (QueryObjectsRequest request)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
|
Future<QueryObjectsResult> |
queryObjectsAsync (QueryObjectsRequest request,
AsyncHandler<QueryObjectsRequest,QueryObjectsResult> asyncHandler)
Queries the specified pipeline for the names of objects that match the specified set of conditions.
|
Future<RemoveTagsResult> |
removeTagsAsync (RemoveTagsRequest request)
Removes existing tags from the specified pipeline.
|
Future<RemoveTagsResult> |
removeTagsAsync (RemoveTagsRequest request,
AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)
Removes existing tags from the specified pipeline.
|
Future<ReportTaskProgressResult> |
reportTaskProgressAsync (ReportTaskProgressRequest request)
Task runners call
ReportTaskProgress when assigned a task to acknowledge that it has the task. |
Future<ReportTaskProgressResult> |
reportTaskProgressAsync (ReportTaskProgressRequest request,
AsyncHandler<ReportTaskProgressRequest,ReportTaskProgressResult> asyncHandler)
Task runners call
ReportTaskProgress when assigned a task to acknowledge that it has the task. |
Future<ReportTaskRunnerHeartbeatResult> |
reportTaskRunnerHeartbeatAsync (ReportTaskRunnerHeartbeatRequest request)
Task runners call
ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. |
Future<ReportTaskRunnerHeartbeatResult> |
reportTaskRunnerHeartbeatAsync (ReportTaskRunnerHeartbeatRequest request,
AsyncHandler<ReportTaskRunnerHeartbeatRequest,ReportTaskRunnerHeartbeatResult> asyncHandler)
Task runners call
ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. |
Future<SetStatusResult> |
setStatusAsync (SetStatusRequest request)
Requests that the status of the specified physical or logical pipeline objects be updated in the specified
pipeline.
|
Future<SetStatusResult> |
setStatusAsync (SetStatusRequest request,
AsyncHandler<SetStatusRequest,SetStatusResult> asyncHandler)
Requests that the status of the specified physical or logical pipeline objects be updated in the specified
pipeline.
|
Future<SetTaskStatusResult> |
setTaskStatusAsync (SetTaskStatusRequest request)
Task runners call
SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide
information about the final status. |
Future<SetTaskStatusResult> |
setTaskStatusAsync (SetTaskStatusRequest request,
AsyncHandler<SetTaskStatusRequest,SetTaskStatusResult> asyncHandler)
Task runners call
SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide
information about the final status. |
void |
shutdown ()
Shuts down the client, releasing all managed resources.
|
Future<ValidatePipelineDefinitionResult> |
validatePipelineDefinitionAsync (ValidatePipelineDefinitionRequest request)
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
|
Future<ValidatePipelineDefinitionResult> |
validatePipelineDefinitionAsync (ValidatePipelineDefinitionRequest request,
AsyncHandler<ValidatePipelineDefinitionRequest,ValidatePipelineDefinitionResult> asyncHandler)
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
|
activatePipeline, addTags, builder, createPipeline, deactivatePipeline, deletePipeline, describeObjects, describePipelines, evaluateExpression, getCachedResponseMetadata, getPipelineDefinition, listPipelines, listPipelines, pollForTask, putPipelineDefinition, queryObjects, removeTags, reportTaskProgress, reportTaskRunnerHeartbeat, setStatus, setTaskStatus, validatePipelineDefinition addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait activatePipeline, addTags, createPipeline, deactivatePipeline, deletePipeline, describeObjects, describePipelines, evaluateExpression, getCachedResponseMetadata, getPipelineDefinition, listPipelines, listPipelines, pollForTask, putPipelineDefinition, queryObjects, removeTags, reportTaskProgress, reportTaskRunnerHeartbeat, setEndpoint, setRegion, setStatus, setTaskStatus, validatePipelineDefinition @Deprecated public DataPipelineAsyncClient()
DataPipelineAsyncClientBuilder.defaultClient() 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).
@Deprecated public DataPipelineAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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().
clientConfiguration - The client configuration options controlling how this client connects to AWS Data Pipeline (ex: proxy
settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int) @Deprecated public DataPipelineAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) 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).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int) @Deprecated public DataPipelineAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory) 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.@Deprecated public DataPipelineAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory) 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.@Deprecated public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) 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).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int) @Deprecated public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
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().
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).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int) @Deprecated public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory) 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.@Deprecated public DataPipelineAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory) 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.public static DataPipelineAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<ActivatePipelineResult> activatePipelineAsync(ActivatePipelineRequest request)
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.
activatePipelineAsync in interface DataPipelineAsync request - Contains the parameters for ActivatePipeline.public Future<ActivatePipelineResult> activatePipelineAsync(ActivatePipelineRequest request, AsyncHandler<ActivatePipelineRequest,ActivatePipelineResult> asyncHandler)
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.
activatePipelineAsync in interface DataPipelineAsync 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.public Future<AddTagsResult> addTagsAsync(AddTagsRequest request)
DataPipelineAsync Adds or modifies tags for the specified pipeline.
addTagsAsync in interface DataPipelineAsync request - Contains the parameters for AddTags.public Future<AddTagsResult> addTagsAsync(AddTagsRequest request, AsyncHandler<AddTagsRequest,AddTagsResult> asyncHandler)
DataPipelineAsync Adds or modifies tags for the specified pipeline.
addTagsAsync in interface DataPipelineAsync 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.public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request)
DataPipelineAsync Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
createPipelineAsync in interface DataPipelineAsync request - Contains the parameters for CreatePipeline.public Future<CreatePipelineResult> createPipelineAsync(CreatePipelineRequest request, AsyncHandler<CreatePipelineRequest,CreatePipelineResult> asyncHandler)
DataPipelineAsync Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
createPipelineAsync in interface DataPipelineAsync 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.public Future<DeactivatePipelineResult> deactivatePipelineAsync(DeactivatePipelineRequest request)
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.
deactivatePipelineAsync in interface DataPipelineAsync request - Contains the parameters for DeactivatePipeline.public Future<DeactivatePipelineResult> deactivatePipelineAsync(DeactivatePipelineRequest request, AsyncHandler<DeactivatePipelineRequest,DeactivatePipelineResult> asyncHandler)
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.
deactivatePipelineAsync in interface DataPipelineAsync 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.public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request)
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.
deletePipelineAsync in interface DataPipelineAsync request - Contains the parameters for DeletePipeline.public Future<DeletePipelineResult> deletePipelineAsync(DeletePipelineRequest request, AsyncHandler<DeletePipelineRequest,DeletePipelineResult> asyncHandler)
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.
deletePipelineAsync in interface DataPipelineAsync 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.public Future<DescribeObjectsResult> describeObjectsAsync(DescribeObjectsRequest request)
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.
describeObjectsAsync in interface DataPipelineAsync request - Contains the parameters for DescribeObjects.public Future<DescribeObjectsResult> describeObjectsAsync(DescribeObjectsRequest request, AsyncHandler<DescribeObjectsRequest,DescribeObjectsResult> asyncHandler)
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.
describeObjectsAsync in interface DataPipelineAsync 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.public Future<DescribePipelinesResult> describePipelinesAsync(DescribePipelinesRequest request)
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.
describePipelinesAsync in interface DataPipelineAsync request - Contains the parameters for DescribePipelines.public Future<DescribePipelinesResult> describePipelinesAsync(DescribePipelinesRequest request, AsyncHandler<DescribePipelinesRequest,DescribePipelinesResult> asyncHandler)
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.
describePipelinesAsync in interface DataPipelineAsync 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.public Future<EvaluateExpressionResult> evaluateExpressionAsync(EvaluateExpressionRequest request)
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.
evaluateExpressionAsync in interface DataPipelineAsync request - Contains the parameters for EvaluateExpression.public Future<EvaluateExpressionResult> evaluateExpressionAsync(EvaluateExpressionRequest request, AsyncHandler<EvaluateExpressionRequest,EvaluateExpressionResult> asyncHandler)
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.
evaluateExpressionAsync in interface DataPipelineAsync 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.public Future<GetPipelineDefinitionResult> getPipelineDefinitionAsync(GetPipelineDefinitionRequest request)
DataPipelineAsync
Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the
pipeline definition that you provided using PutPipelineDefinition.
getPipelineDefinitionAsync in interface DataPipelineAsync request - Contains the parameters for GetPipelineDefinition.public Future<GetPipelineDefinitionResult> getPipelineDefinitionAsync(GetPipelineDefinitionRequest request, AsyncHandler<GetPipelineDefinitionRequest,GetPipelineDefinitionResult> asyncHandler)
DataPipelineAsync
Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the
pipeline definition that you provided using PutPipelineDefinition.
getPipelineDefinitionAsync in interface DataPipelineAsync 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.public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request)
DataPipelineAsync Lists the pipeline identifiers for all active pipelines that you have permission to access.
listPipelinesAsync in interface DataPipelineAsync request - Contains the parameters for ListPipelines.public Future<ListPipelinesResult> listPipelinesAsync(ListPipelinesRequest request, AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
DataPipelineAsync Lists the pipeline identifiers for all active pipelines that you have permission to access.
listPipelinesAsync in interface DataPipelineAsync 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.public Future<ListPipelinesResult> listPipelinesAsync()
listPipelinesAsync in interface DataPipelineAsync listPipelinesAsync(ListPipelinesRequest) public Future<ListPipelinesResult> listPipelinesAsync(AsyncHandler<ListPipelinesRequest,ListPipelinesResult> asyncHandler)
listPipelinesAsync in interface DataPipelineAsync listPipelinesAsync(ListPipelinesRequest, com.amazonaws.handlers.AsyncHandler) public Future<PollForTaskResult> pollForTaskAsync(PollForTaskRequest request)
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.
pollForTaskAsync in interface DataPipelineAsync request - Contains the parameters for PollForTask.public Future<PollForTaskResult> pollForTaskAsync(PollForTaskRequest request, AsyncHandler<PollForTaskRequest,PollForTaskResult> asyncHandler)
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.
pollForTaskAsync in interface DataPipelineAsync 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.public Future<PutPipelineDefinitionResult> putPipelineDefinitionAsync(PutPipelineDefinitionRequest request)
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.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the
GetPipelineDefinition action.
putPipelineDefinitionAsync in interface DataPipelineAsync request - Contains the parameters for PutPipelineDefinition.public Future<PutPipelineDefinitionResult> putPipelineDefinitionAsync(PutPipelineDefinitionRequest request, AsyncHandler<PutPipelineDefinitionRequest,PutPipelineDefinitionResult> asyncHandler)
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.
Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the
GetPipelineDefinition action.
putPipelineDefinitionAsync in interface DataPipelineAsync 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.public Future<QueryObjectsResult> queryObjectsAsync(QueryObjectsRequest request)
DataPipelineAsync Queries the specified pipeline for the names of objects that match the specified set of conditions.
queryObjectsAsync in interface DataPipelineAsync request - Contains the parameters for QueryObjects.public Future<QueryObjectsResult> queryObjectsAsync(QueryObjectsRequest request, AsyncHandler<QueryObjectsRequest,QueryObjectsResult> asyncHandler)
DataPipelineAsync Queries the specified pipeline for the names of objects that match the specified set of conditions.
queryObjectsAsync in interface DataPipelineAsync 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.public Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest request)
DataPipelineAsync Removes existing tags from the specified pipeline.
removeTagsAsync in interface DataPipelineAsync request - Contains the parameters for RemoveTags.public Future<RemoveTagsResult> removeTagsAsync(RemoveTagsRequest request, AsyncHandler<RemoveTagsRequest,RemoveTagsResult> asyncHandler)
DataPipelineAsync Removes existing tags from the specified pipeline.
removeTagsAsync in interface DataPipelineAsync 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.public Future<ReportTaskProgressResult> reportTaskProgressAsync(ReportTaskProgressRequest request)
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.
reportTaskProgressAsync in interface DataPipelineAsync request - Contains the parameters for ReportTaskProgress.public Future<ReportTaskProgressResult> reportTaskProgressAsync(ReportTaskProgressRequest request, AsyncHandler<ReportTaskProgressRequest,ReportTaskProgressResult> asyncHandler)
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.
reportTaskProgressAsync in interface DataPipelineAsync 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.public Future<ReportTaskRunnerHeartbeatResult> reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest request)
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.
reportTaskRunnerHeartbeatAsync in interface DataPipelineAsync request - Contains the parameters for ReportTaskRunnerHeartbeat.public Future<ReportTaskRunnerHeartbeatResult> reportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest request, AsyncHandler<ReportTaskRunnerHeartbeatRequest,ReportTaskRunnerHeartbeatResult> asyncHandler)
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.
reportTaskRunnerHeartbeatAsync in interface DataPipelineAsync 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.public Future<SetStatusResult> setStatusAsync(SetStatusRequest request)
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.
setStatusAsync in interface DataPipelineAsync request - Contains the parameters for SetStatus.public Future<SetStatusResult> setStatusAsync(SetStatusRequest request, AsyncHandler<SetStatusRequest,SetStatusResult> asyncHandler)
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.
setStatusAsync in interface DataPipelineAsync 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.public Future<SetTaskStatusResult> setTaskStatusAsync(SetTaskStatusRequest request)
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.
setTaskStatusAsync in interface DataPipelineAsync request - Contains the parameters for SetTaskStatus.public Future<SetTaskStatusResult> setTaskStatusAsync(SetTaskStatusRequest request, AsyncHandler<SetTaskStatusRequest,SetTaskStatusResult> asyncHandler)
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.
setTaskStatusAsync in interface DataPipelineAsync 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.public Future<ValidatePipelineDefinitionResult> validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest request)
DataPipelineAsync Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
validatePipelineDefinitionAsync in interface DataPipelineAsync request - Contains the parameters for ValidatePipelineDefinition.public Future<ValidatePipelineDefinitionResult> validatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest request, AsyncHandler<ValidatePipelineDefinitionRequest,ValidatePipelineDefinitionResult> asyncHandler)
DataPipelineAsync Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
validatePipelineDefinitionAsync in interface DataPipelineAsync 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface DataPipeline shutdown in class DataPipelineClient