AbstractDataPipeline (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.datapipeline.AbstractDataPipeline

All Implemented Interfaces:

DataPipeline

Direct Known Subclasses:

AbstractDataPipelineAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractDataPipeline
extends Object
implements DataPipeline
```
Abstract implementation of DataPipeline. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.datapipeline.DataPipeline
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActivatePipelineResult`	`activatePipeline(ActivatePipelineRequest request)` Validates the specified pipeline and starts processing pipeline tasks.
`AddTagsResult`	`addTags(AddTagsRequest request)` Adds or modifies tags for the specified pipeline.
`CreatePipelineResult`	`createPipeline(CreatePipelineRequest request)` Creates a new, empty pipeline.
`DeactivatePipelineResult`	`deactivatePipeline(DeactivatePipelineRequest request)` Deactivates the specified running pipeline.
`DeletePipelineResult`	`deletePipeline(DeletePipelineRequest request)` Deletes a pipeline, its pipeline definition, and its run history.
`DescribeObjectsResult`	`describeObjects(DescribeObjectsRequest request)` Gets the object definitions for a set of objects associated with the pipeline.
`DescribePipelinesResult`	`describePipelines(DescribePipelinesRequest request)` Retrieves metadata about one or more pipelines.
`EvaluateExpressionResult`	`evaluateExpression(EvaluateExpressionRequest request)` Task runners call `EvaluateExpression` to evaluate a string in the context of the specified object.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetPipelineDefinitionResult`	`getPipelineDefinition(GetPipelineDefinitionRequest request)` Gets the definition of the specified pipeline.
`ListPipelinesResult`	`listPipelines()` Simplified method form for invoking the ListPipelines operation.
`ListPipelinesResult`	`listPipelines(ListPipelinesRequest request)` Lists the pipeline identifiers for all active pipelines that you have permission to access.
`PollForTaskResult`	`pollForTask(PollForTaskRequest request)` Task runners call `PollForTask` to receive a task to perform from AWS Data Pipeline.
`PutPipelineDefinitionResult`	`putPipelineDefinition(PutPipelineDefinitionRequest request)` Adds tasks, schedules, and preconditions to the specified pipeline.
`QueryObjectsResult`	`queryObjects(QueryObjectsRequest request)` Queries the specified pipeline for the names of objects that match the specified set of conditions.
`RemoveTagsResult`	`removeTags(RemoveTagsRequest request)` Removes existing tags from the specified pipeline.
`ReportTaskProgressResult`	`reportTaskProgress(ReportTaskProgressRequest request)` Task runners call `ReportTaskProgress` when assigned a task to acknowledge that it has the task.
`ReportTaskRunnerHeartbeatResult`	`reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest request)` Task runners call `ReportTaskRunnerHeartbeat` every 15 minutes to indicate that they are operational.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("datapipeline.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `DataPipeline.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`SetStatusResult`	`setStatus(SetStatusRequest request)` Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline.
`SetTaskStatusResult`	`setTaskStatus(SetTaskStatusRequest request)` 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 this client object, releasing any resources that might be held open.
`ValidatePipelineDefinitionResult`	`validatePipelineDefinition(ValidatePipelineDefinitionRequest request)` Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

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

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: DataPipeline
    
    Overrides the default endpoint for this client ("datapipeline.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "datapipeline.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "datapipeline.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface DataPipeline
    
    Parameters:
    
    endpoint - The endpoint (ex: "datapipeline.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "datapipeline.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: DataPipeline
    
    An alternative to DataPipeline.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface DataPipeline
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - activatePipeline
```
public ActivatePipelineResult activatePipeline(ActivatePipelineRequest request)
```
    Description copied from interface: DataPipeline
    
    Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.
    
    If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.
    
    To activate a finished pipeline, modify the end date for the pipeline and then activate it.
    
    Specified by:
    
    activatePipeline in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for ActivatePipeline.
    
    Returns:
    
    Result of the ActivatePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - addTags
```
public AddTagsResult addTags(AddTagsRequest request)
```
    Description copied from interface: DataPipeline
    
    Adds or modifies tags for the specified pipeline.
    
    Specified by:
    
    addTags in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for AddTags.
    
    Returns:
    
    Result of the AddTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPipeline
```
public CreatePipelineResult createPipeline(CreatePipelineRequest request)
```
    Description copied from interface: DataPipeline
    
    Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.
    
    Specified by:
    
    createPipeline in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for CreatePipeline.
    
    Returns:
    
    Result of the CreatePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deactivatePipeline
```
public DeactivatePipelineResult deactivatePipeline(DeactivatePipelineRequest request)
```
    Description copied from interface: DataPipeline
    
    Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.
    
    To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.
    
    Specified by:
    
    deactivatePipeline in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for DeactivatePipeline.
    
    Returns:
    
    Result of the DeactivatePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePipeline
```
public DeletePipelineResult deletePipeline(DeletePipelineRequest request)
```
    Description copied from interface: DataPipeline
    
    Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.
    
    Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed.
    
    Specified by:
    
    deletePipeline in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for DeletePipeline.
    
    Returns:
    
    Result of the DeletePipeline operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeObjects
```
public DescribeObjectsResult describeObjects(DescribeObjectsRequest request)
```
    Description copied from interface: DataPipeline
    
    Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.
    
    Specified by:
    
    describeObjects in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for DescribeObjects.
    
    Returns:
    
    Result of the DescribeObjects operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePipelines
```
public DescribePipelinesResult describePipelines(DescribePipelinesRequest request)
```
    Description copied from interface: DataPipeline
    
    Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.
    
    To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.
    
    Specified by:
    
    describePipelines in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for DescribePipelines.
    
    Returns:
    
    Result of the DescribePipelines operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - evaluateExpression
```
public EvaluateExpressionResult evaluateExpression(EvaluateExpressionRequest request)
```
    Description copied from interface: DataPipeline
    
    Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.
    
    Specified by:
    
    evaluateExpression in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for EvaluateExpression.
    
    Returns:
    
    Result of the EvaluateExpression operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPipelineDefinition
```
public GetPipelineDefinitionResult getPipelineDefinition(GetPipelineDefinitionRequest request)
```
    Description copied from interface: DataPipeline
    
    Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.
    
    Specified by:
    
    getPipelineDefinition in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for GetPipelineDefinition.
    
    Returns:
    
    Result of the GetPipelineDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPipelines
```
public ListPipelinesResult listPipelines(ListPipelinesRequest request)
```
    Description copied from interface: DataPipeline
    
    Lists the pipeline identifiers for all active pipelines that you have permission to access.
    
    Specified by:
    
    listPipelines in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for ListPipelines.
    
    Returns:
    
    Result of the ListPipelines operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPipelines
```
public ListPipelinesResult listPipelines()
```
    Description copied from interface: DataPipeline
    
    Simplified method form for invoking the ListPipelines operation.
    
    Specified by:
    
    listPipelines in interface DataPipeline
    
    See Also:
    
    DataPipeline.listPipelines(ListPipelinesRequest)
  - pollForTask
```
public PollForTaskResult pollForTask(PollForTaskRequest request)
```
    Description copied from interface: DataPipeline
    
    Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.
    
    If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds.
    
    Specified by:
    
    pollForTask in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for PollForTask.
    
    Returns:
    
    Result of the PollForTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putPipelineDefinition
```
public PutPipelineDefinitionResult putPipelineDefinition(PutPipelineDefinitionRequest request)
```
    Description copied from interface: DataPipeline
    Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.
    
    PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.
    1. An object is missing a name or identifier field.
    2. A string or reference field is empty.
    3. The number of objects in the pipeline exceeds the maximum allowed objects.
    4. The pipeline is in a FINISHED state.
    Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.
    Specified by:
    
    putPipelineDefinition in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for PutPipelineDefinition.
    
    Returns:
    
    Result of the PutPipelineDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - queryObjects
```
public QueryObjectsResult queryObjects(QueryObjectsRequest request)
```
    Description copied from interface: DataPipeline
    
    Queries the specified pipeline for the names of objects that match the specified set of conditions.
    
    Specified by:
    
    queryObjects in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for QueryObjects.
    
    Returns:
    
    Result of the QueryObjects operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeTags
```
public RemoveTagsResult removeTags(RemoveTagsRequest request)
```
    Description copied from interface: DataPipeline
    
    Removes existing tags from the specified pipeline.
    
    Specified by:
    
    removeTags in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for RemoveTags.
    
    Returns:
    
    Result of the RemoveTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - reportTaskProgress
```
public ReportTaskProgressResult reportTaskProgress(ReportTaskProgressRequest request)
```
    Description copied from interface: DataPipeline
    
    Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.
    
    If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.
    
    Specified by:
    
    reportTaskProgress in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for ReportTaskProgress.
    
    Returns:
    
    Result of the ReportTaskProgress operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - reportTaskRunnerHeartbeat
```
public ReportTaskRunnerHeartbeatResult reportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest request)
```
    Description copied from interface: DataPipeline
    
    Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.
    
    Specified by:
    
    reportTaskRunnerHeartbeat in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for ReportTaskRunnerHeartbeat.
    
    Returns:
    
    Result of the ReportTaskRunnerHeartbeat operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setStatus
```
public SetStatusResult setStatus(SetStatusRequest request)
```
    Description copied from interface: DataPipeline
    
    Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.
    
    Specified by:
    
    setStatus in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for SetStatus.
    
    Returns:
    
    Result of the SetStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setTaskStatus
```
public SetTaskStatusResult setTaskStatus(SetTaskStatusRequest request)
```
    Description copied from interface: DataPipeline
    
    Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.
    
    Specified by:
    
    setTaskStatus in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for SetTaskStatus.
    
    Returns:
    
    Result of the SetTaskStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - validatePipelineDefinition
```
public ValidatePipelineDefinitionResult validatePipelineDefinition(ValidatePipelineDefinitionRequest request)
```
    Description copied from interface: DataPipeline
    
    Validates the specified pipeline definition to ensure that it is well formed and can be run without error.
    
    Specified by:
    
    validatePipelineDefinition in interface DataPipeline
    
    Parameters:
    
    request - Contains the parameters for ValidatePipelineDefinition.
    
    Returns:
    
    Result of the ValidatePipelineDefinition operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: DataPipeline
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface DataPipeline
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: DataPipeline
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface DataPipeline
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractDataPipeline

Field Summary

Fields inherited from interface com.amazonaws.services.datapipeline.DataPipeline

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

activatePipeline

addTags

createPipeline

deactivatePipeline

deletePipeline

describeObjects

describePipelines

evaluateExpression

getPipelineDefinition

listPipelines

listPipelines

pollForTask

putPipelineDefinition

queryObjects

removeTags

reportTaskProgress

reportTaskRunnerHeartbeat

setStatus

setTaskStatus

validatePipelineDefinition

shutdown

getCachedResponseMetadata