Interface DataPipelineClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault ActivatePipelineResponseactivatePipeline(Consumer<ActivatePipelineRequest.Builder> activatePipelineRequest) Validates the specified pipeline and starts processing pipeline tasks.default ActivatePipelineResponseactivatePipeline(ActivatePipelineRequest activatePipelineRequest) Validates the specified pipeline and starts processing pipeline tasks.default AddTagsResponseaddTags(Consumer<AddTagsRequest.Builder> addTagsRequest) Adds or modifies tags for the specified pipeline.default AddTagsResponseaddTags(AddTagsRequest addTagsRequest) Adds or modifies tags for the specified pipeline.static DataPipelineClientBuilderbuilder()Create a builder that can be used to configure and create aDataPipelineClient.static DataPipelineClientcreate()Create aDataPipelineClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreatePipelineResponsecreatePipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) Creates a new, empty pipeline.default CreatePipelineResponsecreatePipeline(CreatePipelineRequest createPipelineRequest) Creates a new, empty pipeline.default DeactivatePipelineResponsedeactivatePipeline(Consumer<DeactivatePipelineRequest.Builder> deactivatePipelineRequest) Deactivates the specified running pipeline.default DeactivatePipelineResponsedeactivatePipeline(DeactivatePipelineRequest deactivatePipelineRequest) Deactivates the specified running pipeline.default DeletePipelineResponsedeletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) Deletes a pipeline, its pipeline definition, and its run history.default DeletePipelineResponsedeletePipeline(DeletePipelineRequest deletePipelineRequest) Deletes a pipeline, its pipeline definition, and its run history.default DescribeObjectsResponsedescribeObjects(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest) Gets the object definitions for a set of objects associated with the pipeline.default DescribeObjectsResponsedescribeObjects(DescribeObjectsRequest describeObjectsRequest) Gets the object definitions for a set of objects associated with the pipeline.default DescribeObjectsIterabledescribeObjectsPaginator(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest) This is a variant ofdescribeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)operation.default DescribeObjectsIterabledescribeObjectsPaginator(DescribeObjectsRequest describeObjectsRequest) This is a variant ofdescribeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)operation.default DescribePipelinesResponsedescribePipelines(Consumer<DescribePipelinesRequest.Builder> describePipelinesRequest) Retrieves metadata about one or more pipelines.default DescribePipelinesResponsedescribePipelines(DescribePipelinesRequest describePipelinesRequest) Retrieves metadata about one or more pipelines.default EvaluateExpressionResponseevaluateExpression(Consumer<EvaluateExpressionRequest.Builder> evaluateExpressionRequest) Task runners callEvaluateExpressionto evaluate a string in the context of the specified object.default EvaluateExpressionResponseevaluateExpression(EvaluateExpressionRequest evaluateExpressionRequest) Task runners callEvaluateExpressionto evaluate a string in the context of the specified object.default GetPipelineDefinitionResponsegetPipelineDefinition(Consumer<GetPipelineDefinitionRequest.Builder> getPipelineDefinitionRequest) Gets the definition of the specified pipeline.default GetPipelineDefinitionResponsegetPipelineDefinition(GetPipelineDefinitionRequest getPipelineDefinitionRequest) Gets the definition of the specified pipeline.default ListPipelinesResponseLists the pipeline identifiers for all active pipelines that you have permission to access.default ListPipelinesResponselistPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) Lists the pipeline identifiers for all active pipelines that you have permission to access.default ListPipelinesResponselistPipelines(ListPipelinesRequest listPipelinesRequest) Lists the pipeline identifiers for all active pipelines that you have permission to access.default ListPipelinesIterableThis is a variant oflistPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)operation.default ListPipelinesIterablelistPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) This is a variant oflistPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)operation.default ListPipelinesIterablelistPipelinesPaginator(ListPipelinesRequest listPipelinesRequest) This is a variant oflistPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)operation.default PollForTaskResponsepollForTask(Consumer<PollForTaskRequest.Builder> pollForTaskRequest) Task runners callPollForTaskto receive a task to perform from AWS Data Pipeline.default PollForTaskResponsepollForTask(PollForTaskRequest pollForTaskRequest) Task runners callPollForTaskto receive a task to perform from AWS Data Pipeline.default PutPipelineDefinitionResponseputPipelineDefinition(Consumer<PutPipelineDefinitionRequest.Builder> putPipelineDefinitionRequest) Adds tasks, schedules, and preconditions to the specified pipeline.default PutPipelineDefinitionResponseputPipelineDefinition(PutPipelineDefinitionRequest putPipelineDefinitionRequest) Adds tasks, schedules, and preconditions to the specified pipeline.default QueryObjectsResponsequeryObjects(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest) Queries the specified pipeline for the names of objects that match the specified set of conditions.default QueryObjectsResponsequeryObjects(QueryObjectsRequest queryObjectsRequest) Queries the specified pipeline for the names of objects that match the specified set of conditions.default QueryObjectsIterablequeryObjectsPaginator(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest) This is a variant ofqueryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest)operation.default QueryObjectsIterablequeryObjectsPaginator(QueryObjectsRequest queryObjectsRequest) This is a variant ofqueryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest)operation.default RemoveTagsResponseremoveTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) Removes existing tags from the specified pipeline.default RemoveTagsResponseremoveTags(RemoveTagsRequest removeTagsRequest) Removes existing tags from the specified pipeline.default ReportTaskProgressResponsereportTaskProgress(Consumer<ReportTaskProgressRequest.Builder> reportTaskProgressRequest) Task runners callReportTaskProgresswhen assigned a task to acknowledge that it has the task.default ReportTaskProgressResponsereportTaskProgress(ReportTaskProgressRequest reportTaskProgressRequest) Task runners callReportTaskProgresswhen assigned a task to acknowledge that it has the task.reportTaskRunnerHeartbeat(Consumer<ReportTaskRunnerHeartbeatRequest.Builder> reportTaskRunnerHeartbeatRequest) Task runners callReportTaskRunnerHeartbeatevery 15 minutes to indicate that they are operational.reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest) Task runners callReportTaskRunnerHeartbeatevery 15 minutes to indicate that they are operational.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault SetStatusResponsesetStatus(Consumer<SetStatusRequest.Builder> setStatusRequest) Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.default SetStatusResponsesetStatus(SetStatusRequest setStatusRequest) Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.default SetTaskStatusResponsesetTaskStatus(Consumer<SetTaskStatusRequest.Builder> setTaskStatusRequest) Task runners callSetTaskStatusto notify AWS Data Pipeline that a task is completed and provide information about the final status.default SetTaskStatusResponsesetTaskStatus(SetTaskStatusRequest setTaskStatusRequest) Task runners callSetTaskStatusto notify AWS Data Pipeline that a task is completed and provide information about the final status.validatePipelineDefinition(Consumer<ValidatePipelineDefinitionRequest.Builder> validatePipelineDefinitionRequest) Validates the specified pipeline definition to ensure that it is well formed and can be run without error.validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest) Validates the specified pipeline definition to ensure that it is well formed and can be run without error.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
activatePipeline
default ActivatePipelineResponse activatePipeline(ActivatePipelineRequest activatePipelineRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException 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.
- Parameters:
activatePipelineRequest- Contains the parameters for ActivatePipeline.- Returns:
- Result of the ActivatePipeline operation returned by the service.
- See Also:
-
activatePipeline
default ActivatePipelineResponse activatePipeline(Consumer<ActivatePipelineRequest.Builder> activatePipelineRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException 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.
This is a convenience which creates an instance of the
ActivatePipelineRequest.Builderavoiding the need to create one manually viaActivatePipelineRequest.builder()- Parameters:
activatePipelineRequest- AConsumerthat will call methods onActivatePipelineRequest.Builderto create a request. Contains the parameters for ActivatePipeline.- Returns:
- Result of the ActivatePipeline operation returned by the service.
- See Also:
-
addTags
default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Adds or modifies tags for the specified pipeline.
- Parameters:
addTagsRequest- Contains the parameters for AddTags.- Returns:
- Result of the AddTags operation returned by the service.
- See Also:
-
addTags
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Adds or modifies tags for the specified pipeline.
This is a convenience which creates an instance of the
AddTagsRequest.Builderavoiding the need to create one manually viaAddTagsRequest.builder()- Parameters:
addTagsRequest- AConsumerthat will call methods onAddTagsRequest.Builderto create a request. Contains the parameters for AddTags.- Returns:
- Result of the AddTags operation returned by the service.
- See Also:
-
createPipeline
default CreatePipelineResponse createPipeline(CreatePipelineRequest createPipelineRequest) throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
- Parameters:
createPipelineRequest- Contains the parameters for CreatePipeline.- Returns:
- Result of the CreatePipeline operation returned by the service.
- See Also:
-
createPipeline
default CreatePipelineResponse createPipeline(Consumer<CreatePipelineRequest.Builder> createPipelineRequest) throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
This is a convenience which creates an instance of the
CreatePipelineRequest.Builderavoiding the need to create one manually viaCreatePipelineRequest.builder()- Parameters:
createPipelineRequest- AConsumerthat will call methods onCreatePipelineRequest.Builderto create a request. Contains the parameters for CreatePipeline.- Returns:
- Result of the CreatePipeline operation returned by the service.
- See Also:
-
deactivatePipeline
default DeactivatePipelineResponse deactivatePipeline(DeactivatePipelineRequest deactivatePipelineRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Deactivates the specified running pipeline. The pipeline is set to the
DEACTIVATINGstate 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.
- Parameters:
deactivatePipelineRequest- Contains the parameters for DeactivatePipeline.- Returns:
- Result of the DeactivatePipeline operation returned by the service.
- See Also:
-
deactivatePipeline
default DeactivatePipelineResponse deactivatePipeline(Consumer<DeactivatePipelineRequest.Builder> deactivatePipelineRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Deactivates the specified running pipeline. The pipeline is set to the
DEACTIVATINGstate 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.
This is a convenience which creates an instance of the
DeactivatePipelineRequest.Builderavoiding the need to create one manually viaDeactivatePipelineRequest.builder()- Parameters:
deactivatePipelineRequest- AConsumerthat will call methods onDeactivatePipelineRequest.Builderto create a request. Contains the parameters for DeactivatePipeline.- Returns:
- Result of the DeactivatePipeline operation returned by the service.
- See Also:
-
deletePipeline
default DeletePipelineResponse deletePipeline(DeletePipelineRequest deletePipelineRequest) throws PipelineNotFoundException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException 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
PAUSEon individual components. Components that are paused by SetStatus can be resumed.- Parameters:
deletePipelineRequest- Contains the parameters for DeletePipeline.- Returns:
- Result of the DeletePipeline operation returned by the service.
- See Also:
-
deletePipeline
default DeletePipelineResponse deletePipeline(Consumer<DeletePipelineRequest.Builder> deletePipelineRequest) throws PipelineNotFoundException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException 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
PAUSEon individual components. Components that are paused by SetStatus can be resumed.
This is a convenience which creates an instance of the
DeletePipelineRequest.Builderavoiding the need to create one manually viaDeletePipelineRequest.builder()- Parameters:
deletePipelineRequest- AConsumerthat will call methods onDeletePipelineRequest.Builderto create a request. Contains the parameters for DeletePipeline.- Returns:
- Result of the DeletePipeline operation returned by the service.
- See Also:
-
describeObjects
default DescribeObjectsResponse describeObjects(DescribeObjectsRequest describeObjectsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException 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.
- Parameters:
describeObjectsRequest- Contains the parameters for DescribeObjects.- Returns:
- Result of the DescribeObjects operation returned by the service.
- See Also:
-
describeObjects
default DescribeObjectsResponse describeObjects(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException 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.
This is a convenience which creates an instance of the
DescribeObjectsRequest.Builderavoiding the need to create one manually viaDescribeObjectsRequest.builder()- Parameters:
describeObjectsRequest- AConsumerthat will call methods onDescribeObjectsRequest.Builderto create a request. Contains the parameters for DescribeObjects.- Returns:
- Result of the DescribeObjects operation returned by the service.
- See Also:
-
describeObjectsPaginator
default DescribeObjectsIterable describeObjectsPaginator(DescribeObjectsRequest describeObjectsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException This is a variant of
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsIterable responses = client.describeObjectsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsIterable responses = client .describeObjectsPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.DescribeObjectsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsIterable responses = client.describeObjectsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)operation.- Parameters:
describeObjectsRequest- Contains the parameters for DescribeObjects.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeObjectsPaginator
default DescribeObjectsIterable describeObjectsPaginator(Consumer<DescribeObjectsRequest.Builder> describeObjectsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException This is a variant of
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsIterable responses = client.describeObjectsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsIterable responses = client .describeObjectsPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.DescribeObjectsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datapipeline.paginators.DescribeObjectsIterable responses = client.describeObjectsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeObjects(software.amazon.awssdk.services.datapipeline.model.DescribeObjectsRequest)operation.
This is a convenience which creates an instance of the
DescribeObjectsRequest.Builderavoiding the need to create one manually viaDescribeObjectsRequest.builder()- Parameters:
describeObjectsRequest- AConsumerthat will call methods onDescribeObjectsRequest.Builderto create a request. Contains the parameters for DescribeObjects.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePipelines
default DescribePipelinesResponse describePipelines(DescribePipelinesRequest describePipelinesRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException 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.
- Parameters:
describePipelinesRequest- Contains the parameters for DescribePipelines.- Returns:
- Result of the DescribePipelines operation returned by the service.
- See Also:
-
describePipelines
default DescribePipelinesResponse describePipelines(Consumer<DescribePipelinesRequest.Builder> describePipelinesRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException 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.
This is a convenience which creates an instance of the
DescribePipelinesRequest.Builderavoiding the need to create one manually viaDescribePipelinesRequest.builder()- Parameters:
describePipelinesRequest- AConsumerthat will call methods onDescribePipelinesRequest.Builderto create a request. Contains the parameters for DescribePipelines.- Returns:
- Result of the DescribePipelines operation returned by the service.
- See Also:
-
evaluateExpression
default EvaluateExpressionResponse evaluateExpression(EvaluateExpressionRequest evaluateExpressionRequest) throws InternalServiceErrorException, TaskNotFoundException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
EvaluateExpressionto evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.- Parameters:
evaluateExpressionRequest- Contains the parameters for EvaluateExpression.- Returns:
- Result of the EvaluateExpression operation returned by the service.
- See Also:
-
evaluateExpression
default EvaluateExpressionResponse evaluateExpression(Consumer<EvaluateExpressionRequest.Builder> evaluateExpressionRequest) throws InternalServiceErrorException, TaskNotFoundException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
EvaluateExpressionto evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.
This is a convenience which creates an instance of the
EvaluateExpressionRequest.Builderavoiding the need to create one manually viaEvaluateExpressionRequest.builder()- Parameters:
evaluateExpressionRequest- AConsumerthat will call methods onEvaluateExpressionRequest.Builderto create a request. Contains the parameters for EvaluateExpression.- Returns:
- Result of the EvaluateExpression operation returned by the service.
- See Also:
-
getPipelineDefinition
default GetPipelineDefinitionResponse getPipelineDefinition(GetPipelineDefinitionRequest getPipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Gets the definition of the specified pipeline. You can call
GetPipelineDefinitionto retrieve the pipeline definition that you provided using PutPipelineDefinition.- Parameters:
getPipelineDefinitionRequest- Contains the parameters for GetPipelineDefinition.- Returns:
- Result of the GetPipelineDefinition operation returned by the service.
- See Also:
-
getPipelineDefinition
default GetPipelineDefinitionResponse getPipelineDefinition(Consumer<GetPipelineDefinitionRequest.Builder> getPipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Gets the definition of the specified pipeline. You can call
GetPipelineDefinitionto retrieve the pipeline definition that you provided using PutPipelineDefinition.
This is a convenience which creates an instance of the
GetPipelineDefinitionRequest.Builderavoiding the need to create one manually viaGetPipelineDefinitionRequest.builder()- Parameters:
getPipelineDefinitionRequest- AConsumerthat will call methods onGetPipelineDefinitionRequest.Builderto create a request. Contains the parameters for GetPipelineDefinition.- Returns:
- Result of the GetPipelineDefinition operation returned by the service.
- See Also:
-
listPipelines
default ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest) throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Lists the pipeline identifiers for all active pipelines that you have permission to access.
- Parameters:
listPipelinesRequest- Contains the parameters for ListPipelines.- Returns:
- Result of the ListPipelines operation returned by the service.
- See Also:
-
listPipelines
default ListPipelinesResponse listPipelines(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Lists the pipeline identifiers for all active pipelines that you have permission to access.
This is a convenience which creates an instance of the
ListPipelinesRequest.Builderavoiding the need to create one manually viaListPipelinesRequest.builder()- Parameters:
listPipelinesRequest- AConsumerthat will call methods onListPipelinesRequest.Builderto create a request. Contains the parameters for ListPipelines.- Returns:
- Result of the ListPipelines operation returned by the service.
- See Also:
-
listPipelines
default ListPipelinesResponse listPipelines() throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineExceptionLists the pipeline identifiers for all active pipelines that you have permission to access.
- Returns:
- Result of the ListPipelines operation returned by the service.
- See Also:
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator() throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineExceptionThis is a variant of
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client .listPipelinesPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator(ListPipelinesRequest listPipelinesRequest) throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException This is a variant of
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client .listPipelinesPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)operation.- Parameters:
listPipelinesRequest- Contains the parameters for ListPipelines.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPipelinesPaginator
default ListPipelinesIterable listPipelinesPaginator(Consumer<ListPipelinesRequest.Builder> listPipelinesRequest) throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException This is a variant of
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client .listPipelinesPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.ListPipelinesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datapipeline.paginators.ListPipelinesIterable responses = client.listPipelinesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPipelines(software.amazon.awssdk.services.datapipeline.model.ListPipelinesRequest)operation.
This is a convenience which creates an instance of the
ListPipelinesRequest.Builderavoiding the need to create one manually viaListPipelinesRequest.builder()- Parameters:
listPipelinesRequest- AConsumerthat will call methods onListPipelinesRequest.Builderto create a request. Contains the parameters for ListPipelines.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
pollForTask
default PollForTaskResponse pollForTask(PollForTaskRequest pollForTaskRequest) throws InternalServiceErrorException, InvalidRequestException, TaskNotFoundException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
PollForTaskto receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for theworkerGroupparameter. The task returned can come from any of the pipelines that match theworkerGroupvalue 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,
PollForTaskreturns a response immediately. If no tasks are available in the queue,PollForTaskuses 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 callPollForTaskagain on the sameworkerGroupuntil it receives a response, and this can take up to 90 seconds.- Parameters:
pollForTaskRequest- Contains the parameters for PollForTask.- Returns:
- Result of the PollForTask operation returned by the service.
- See Also:
-
pollForTask
default PollForTaskResponse pollForTask(Consumer<PollForTaskRequest.Builder> pollForTaskRequest) throws InternalServiceErrorException, InvalidRequestException, TaskNotFoundException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
PollForTaskto receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for theworkerGroupparameter. The task returned can come from any of the pipelines that match theworkerGroupvalue 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,
PollForTaskreturns a response immediately. If no tasks are available in the queue,PollForTaskuses 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 callPollForTaskagain on the sameworkerGroupuntil it receives a response, and this can take up to 90 seconds.
This is a convenience which creates an instance of the
PollForTaskRequest.Builderavoiding the need to create one manually viaPollForTaskRequest.builder()- Parameters:
pollForTaskRequest- AConsumerthat will call methods onPollForTaskRequest.Builderto create a request. Contains the parameters for PollForTask.- Returns:
- Result of the PollForTask operation returned by the service.
- See Also:
-
putPipelineDefinition
default PutPipelineDefinitionResponse putPipelineDefinition(PutPipelineDefinitionRequest putPipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Adds tasks, schedules, and preconditions to the specified pipeline. You can use
PutPipelineDefinitionto populate a new pipeline.PutPipelineDefinitionalso validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.- An object is missing a name or identifier field.
- A string or reference field is empty.
- The number of objects in the pipeline exceeds the maximum allowed objects.
- The pipeline is in a FINISHED state.
Pipeline object definitions are passed to the
PutPipelineDefinitionaction and returned by the GetPipelineDefinition action.- Parameters:
putPipelineDefinitionRequest- Contains the parameters for PutPipelineDefinition.- Returns:
- Result of the PutPipelineDefinition operation returned by the service.
- See Also:
-
putPipelineDefinition
default PutPipelineDefinitionResponse putPipelineDefinition(Consumer<PutPipelineDefinitionRequest.Builder> putPipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Adds tasks, schedules, and preconditions to the specified pipeline. You can use
PutPipelineDefinitionto populate a new pipeline.PutPipelineDefinitionalso validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.- An object is missing a name or identifier field.
- A string or reference field is empty.
- The number of objects in the pipeline exceeds the maximum allowed objects.
- The pipeline is in a FINISHED state.
Pipeline object definitions are passed to the
PutPipelineDefinitionaction and returned by the GetPipelineDefinition action.
This is a convenience which creates an instance of the
PutPipelineDefinitionRequest.Builderavoiding the need to create one manually viaPutPipelineDefinitionRequest.builder()- Parameters:
putPipelineDefinitionRequest- AConsumerthat will call methods onPutPipelineDefinitionRequest.Builderto create a request. Contains the parameters for PutPipelineDefinition.- Returns:
- Result of the PutPipelineDefinition operation returned by the service.
- See Also:
-
queryObjects
default QueryObjectsResponse queryObjects(QueryObjectsRequest queryObjectsRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Queries the specified pipeline for the names of objects that match the specified set of conditions.
- Parameters:
queryObjectsRequest- Contains the parameters for QueryObjects.- Returns:
- Result of the QueryObjects operation returned by the service.
- See Also:
-
queryObjects
default QueryObjectsResponse queryObjects(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Queries the specified pipeline for the names of objects that match the specified set of conditions.
This is a convenience which creates an instance of the
QueryObjectsRequest.Builderavoiding the need to create one manually viaQueryObjectsRequest.builder()- Parameters:
queryObjectsRequest- AConsumerthat will call methods onQueryObjectsRequest.Builderto create a request. Contains the parameters for QueryObjects.- Returns:
- Result of the QueryObjects operation returned by the service.
- See Also:
-
queryObjectsPaginator
default QueryObjectsIterable queryObjectsPaginator(QueryObjectsRequest queryObjectsRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException This is a variant of
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datapipeline.paginators.QueryObjectsIterable responses = client.queryObjectsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datapipeline.paginators.QueryObjectsIterable responses = client .queryObjectsPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.QueryObjectsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datapipeline.paginators.QueryObjectsIterable responses = client.queryObjectsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest)operation.- Parameters:
queryObjectsRequest- Contains the parameters for QueryObjects.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
queryObjectsPaginator
default QueryObjectsIterable queryObjectsPaginator(Consumer<QueryObjectsRequest.Builder> queryObjectsRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException This is a variant of
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.datapipeline.paginators.QueryObjectsIterable responses = client.queryObjectsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.datapipeline.paginators.QueryObjectsIterable responses = client .queryObjectsPaginator(request); for (software.amazon.awssdk.services.datapipeline.model.QueryObjectsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.datapipeline.paginators.QueryObjectsIterable responses = client.queryObjectsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryObjects(software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest)operation.
This is a convenience which creates an instance of the
QueryObjectsRequest.Builderavoiding the need to create one manually viaQueryObjectsRequest.builder()- Parameters:
queryObjectsRequest- AConsumerthat will call methods onQueryObjectsRequest.Builderto create a request. Contains the parameters for QueryObjects.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
removeTags
default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Removes existing tags from the specified pipeline.
- Parameters:
removeTagsRequest- Contains the parameters for RemoveTags.- Returns:
- Result of the RemoveTags operation returned by the service.
- See Also:
-
removeTags
default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Removes existing tags from the specified pipeline.
This is a convenience which creates an instance of the
RemoveTagsRequest.Builderavoiding the need to create one manually viaRemoveTagsRequest.builder()- Parameters:
removeTagsRequest- AConsumerthat will call methods onRemoveTagsRequest.Builderto create a request. Contains the parameters for RemoveTags.- Returns:
- Result of the RemoveTags operation returned by the service.
- See Also:
-
reportTaskProgress
default ReportTaskProgressResponse reportTaskProgress(ReportTaskProgressRequest reportTaskProgressRequest) throws InternalServiceErrorException, InvalidRequestException, TaskNotFoundException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
ReportTaskProgresswhen 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 areportProgressTimeoutfield 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
ReportTaskProgressevery 60 seconds.- Parameters:
reportTaskProgressRequest- Contains the parameters for ReportTaskProgress.- Returns:
- Result of the ReportTaskProgress operation returned by the service.
- See Also:
-
reportTaskProgress
default ReportTaskProgressResponse reportTaskProgress(Consumer<ReportTaskProgressRequest.Builder> reportTaskProgressRequest) throws InternalServiceErrorException, InvalidRequestException, TaskNotFoundException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
ReportTaskProgresswhen 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 areportProgressTimeoutfield 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
ReportTaskProgressevery 60 seconds.
This is a convenience which creates an instance of the
ReportTaskProgressRequest.Builderavoiding the need to create one manually viaReportTaskProgressRequest.builder()- Parameters:
reportTaskProgressRequest- AConsumerthat will call methods onReportTaskProgressRequest.Builderto create a request. Contains the parameters for ReportTaskProgress.- Returns:
- Result of the ReportTaskProgress operation returned by the service.
- See Also:
-
reportTaskRunnerHeartbeat
default ReportTaskRunnerHeartbeatResponse reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest reportTaskRunnerHeartbeatRequest) throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
ReportTaskRunnerHeartbeatevery 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.- Parameters:
reportTaskRunnerHeartbeatRequest- Contains the parameters for ReportTaskRunnerHeartbeat.- Returns:
- Result of the ReportTaskRunnerHeartbeat operation returned by the service.
- See Also:
-
reportTaskRunnerHeartbeat
default ReportTaskRunnerHeartbeatResponse reportTaskRunnerHeartbeat(Consumer<ReportTaskRunnerHeartbeatRequest.Builder> reportTaskRunnerHeartbeatRequest) throws InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
ReportTaskRunnerHeartbeatevery 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.
This is a convenience which creates an instance of the
ReportTaskRunnerHeartbeatRequest.Builderavoiding the need to create one manually viaReportTaskRunnerHeartbeatRequest.builder()- Parameters:
reportTaskRunnerHeartbeatRequest- AConsumerthat will call methods onReportTaskRunnerHeartbeatRequest.Builderto create a request. Contains the parameters for ReportTaskRunnerHeartbeat.- Returns:
- Result of the ReportTaskRunnerHeartbeat operation returned by the service.
- See Also:
-
setStatus
default SetStatusResponse setStatus(SetStatusRequest setStatusRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException 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
FINISHEDpipelines and attempting to do so returnsInvalidRequestException.- Parameters:
setStatusRequest- Contains the parameters for SetStatus.- Returns:
- Result of the SetStatus operation returned by the service.
- See Also:
-
setStatus
default SetStatusResponse setStatus(Consumer<SetStatusRequest.Builder> setStatusRequest) throws PipelineNotFoundException, PipelineDeletedException, InternalServiceErrorException, InvalidRequestException, AwsServiceException, SdkClientException, DataPipelineException 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
FINISHEDpipelines and attempting to do so returnsInvalidRequestException.
This is a convenience which creates an instance of the
SetStatusRequest.Builderavoiding the need to create one manually viaSetStatusRequest.builder()- Parameters:
setStatusRequest- AConsumerthat will call methods onSetStatusRequest.Builderto create a request. Contains the parameters for SetStatus.- Returns:
- Result of the SetStatus operation returned by the service.
- See Also:
-
setTaskStatus
default SetTaskStatusResponse setTaskStatus(SetTaskStatusRequest setTaskStatusRequest) throws InternalServiceErrorException, TaskNotFoundException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
SetTaskStatusto 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 callSetTaskStatusfor tasks that are canceled by the web service during a call to ReportTaskProgress.- Parameters:
setTaskStatusRequest- Contains the parameters for SetTaskStatus.- Returns:
- Result of the SetTaskStatus operation returned by the service.
- See Also:
-
setTaskStatus
default SetTaskStatusResponse setTaskStatus(Consumer<SetTaskStatusRequest.Builder> setTaskStatusRequest) throws InternalServiceErrorException, TaskNotFoundException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Task runners call
SetTaskStatusto 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 callSetTaskStatusfor tasks that are canceled by the web service during a call to ReportTaskProgress.
This is a convenience which creates an instance of the
SetTaskStatusRequest.Builderavoiding the need to create one manually viaSetTaskStatusRequest.builder()- Parameters:
setTaskStatusRequest- AConsumerthat will call methods onSetTaskStatusRequest.Builderto create a request. Contains the parameters for SetTaskStatus.- Returns:
- Result of the SetTaskStatus operation returned by the service.
- See Also:
-
validatePipelineDefinition
default ValidatePipelineDefinitionResponse validatePipelineDefinition(ValidatePipelineDefinitionRequest validatePipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
- Parameters:
validatePipelineDefinitionRequest- Contains the parameters for ValidatePipelineDefinition.- Returns:
- Result of the ValidatePipelineDefinition operation returned by the service.
- See Also:
-
validatePipelineDefinition
default ValidatePipelineDefinitionResponse validatePipelineDefinition(Consumer<ValidatePipelineDefinitionRequest.Builder> validatePipelineDefinitionRequest) throws InternalServiceErrorException, InvalidRequestException, PipelineNotFoundException, PipelineDeletedException, AwsServiceException, SdkClientException, DataPipelineException Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
This is a convenience which creates an instance of the
ValidatePipelineDefinitionRequest.Builderavoiding the need to create one manually viaValidatePipelineDefinitionRequest.builder()- Parameters:
validatePipelineDefinitionRequest- AConsumerthat will call methods onValidatePipelineDefinitionRequest.Builderto create a request. Contains the parameters for ValidatePipelineDefinition.- Returns:
- Result of the ValidatePipelineDefinition operation returned by the service.
- See Also:
-
create
Create aDataPipelineClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aDataPipelineClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-