DataPipeline class

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.

Constructors

DataPipeline({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

activatePipeline({required String pipelineId, List<ParameterValue>? parameterValues, DateTime? startTimestamp}) → Future<void>
Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.
addTags({required String pipelineId, required List<Tag> tags}) → Future<void>
Adds or modifies tags for the specified pipeline.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createPipeline({required String name, required String uniqueId, String? description, List<Tag>? tags}) → Future<CreatePipelineOutput>
Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
deactivatePipeline({required String pipelineId, bool? cancelActive}) → Future<void>
Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.
deletePipeline({required String pipelineId}) → Future<void>
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.
describeObjects({required List<String> objectIds, required String pipelineId, bool? evaluateExpressions, String? marker}) → Future<DescribeObjectsOutput>
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.
describePipelines({required List<String> pipelineIds}) → Future<DescribePipelinesOutput>
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.
evaluateExpression({required String expression, required String objectId, required String pipelineId}) → Future<EvaluateExpressionOutput>
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.
getPipelineDefinition({required String pipelineId, String? version}) → Future<GetPipelineDefinitionOutput>
Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.
listPipelines({String? marker}) → Future<ListPipelinesOutput>
Lists the pipeline identifiers for all active pipelines that you have permission to access.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pollForTask({required String workerGroup, String? hostname, InstanceIdentity? instanceIdentity}) → Future<PollForTaskOutput>
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.
putPipelineDefinition({required String pipelineId, required List<PipelineObject> pipelineObjects, List<ParameterObject>? parameterObjects, List<ParameterValue>? parameterValues}) → Future<PutPipelineDefinitionOutput>
Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.
queryObjects({required String pipelineId, required String sphere, int? limit, String? marker, Query? query}) → Future<QueryObjectsOutput>
Queries the specified pipeline for the names of objects that match the specified set of conditions.
removeTags({required String pipelineId, required List<String> tagKeys}) → Future<void>
Removes existing tags from the specified pipeline.
reportTaskProgress({required String taskId, List<Field>? fields}) → Future<ReportTaskProgressOutput>
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.
reportTaskRunnerHeartbeat({required String taskrunnerId, String? hostname, String? workerGroup}) → Future<ReportTaskRunnerHeartbeatOutput>
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.
setStatus({required List<String> objectIds, required String pipelineId, required String status}) → Future<void>
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.
setTaskStatus({required String taskId, required TaskStatus taskStatus, String? errorId, String? errorMessage, String? errorStackTrace}) → Future<void>
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.
toString() → String
A string representation of this object.
inherited
validatePipelineDefinition({required String pipelineId, required List<PipelineObject> pipelineObjects, List<ParameterObject>? parameterObjects, List<ParameterValue>? parameterValues}) → Future<ValidatePipelineDefinitionOutput>
Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

Operators

operator ==(Object other) → bool
The equality operator.
inherited