com.databricks.sdk.service.pipelines

Interface PipelinesService

@Generated
public interface PipelinesService

The Delta Live Tables API allows you to create, edit, delete, start, and view details about pipelines.

Delta Live Tables is a framework for building reliable, maintainable, and testable data processing pipelines. You define the transformations to perform on your data, and Delta Live Tables manages task orchestration, cluster management, monitoring, data quality, and error handling.

Instead of defining your data pipelines using a series of separate Apache Spark tasks, Delta Live Tables manages how your data is transformed based on a target schema you define for each processing step. You can also enforce data quality with Delta Live Tables expectations. Expectations allow you to define expected data quality and specify how to handle records that fail those expectations.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
CreatePipelineResponse	create(CreatePipeline createPipeline) Create a pipeline.
void	delete(DeletePipelineRequest deletePipelineRequest) Delete a pipeline.
GetPipelineResponse	get(GetPipelineRequest getPipelineRequest) Get a pipeline.
GetPipelinePermissionLevelsResponse	getPermissionLevels(GetPipelinePermissionLevelsRequest getPipelinePermissionLevelsRequest) Get pipeline permission levels.
PipelinePermissions	getPermissions(GetPipelinePermissionsRequest getPipelinePermissionsRequest) Get pipeline permissions.
GetUpdateResponse	getUpdate(GetUpdateRequest getUpdateRequest) Get a pipeline update.
ListPipelineEventsResponse	listPipelineEvents(ListPipelineEventsRequest listPipelineEventsRequest) List pipeline events.
ListPipelinesResponse	listPipelines(ListPipelinesRequest listPipelinesRequest) List pipelines.
ListUpdatesResponse	listUpdates(ListUpdatesRequest listUpdatesRequest) List pipeline updates.
PipelinePermissions	setPermissions(PipelinePermissionsRequest pipelinePermissionsRequest) Set pipeline permissions.
StartUpdateResponse	startUpdate(StartUpdate startUpdate) Start a pipeline.
void	stop(StopRequest stopRequest) Stop a pipeline.
void	update(EditPipeline editPipeline) Edit a pipeline.
PipelinePermissions	updatePermissions(PipelinePermissionsRequest pipelinePermissionsRequest) Update pipeline permissions.

Method Detail

create

CreatePipelineResponse create(CreatePipeline createPipeline)

Create a pipeline.

Creates a new data processing pipeline based on the requested configuration. If successful, this method returns the ID of the new pipeline.

delete

void delete(DeletePipelineRequest deletePipelineRequest)

Delete a pipeline.

Deletes a pipeline.

get

GetPipelineResponse get(GetPipelineRequest getPipelineRequest)

Get a pipeline.

getPermissionLevels

GetPipelinePermissionLevelsResponse getPermissionLevels(GetPipelinePermissionLevelsRequest getPipelinePermissionLevelsRequest)

Get pipeline permission levels.

Gets the permission levels that a user can have on an object.

getPermissions

PipelinePermissions getPermissions(GetPipelinePermissionsRequest getPipelinePermissionsRequest)

Get pipeline permissions.

Gets the permissions of a pipeline. Pipelines can inherit permissions from their root object.

getUpdate

GetUpdateResponse getUpdate(GetUpdateRequest getUpdateRequest)

Get a pipeline update.

Gets an update from an active pipeline.

listPipelineEvents

ListPipelineEventsResponse listPipelineEvents(ListPipelineEventsRequest listPipelineEventsRequest)

List pipeline events.

Retrieves events for a pipeline.

listPipelines

ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest)

List pipelines.

Lists pipelines defined in the Delta Live Tables system.

listUpdates

ListUpdatesResponse listUpdates(ListUpdatesRequest listUpdatesRequest)

List pipeline updates.

List updates for an active pipeline.

setPermissions

PipelinePermissions setPermissions(PipelinePermissionsRequest pipelinePermissionsRequest)

Set pipeline permissions.

Sets permissions on a pipeline. Pipelines can inherit permissions from their root object.

startUpdate

StartUpdateResponse startUpdate(StartUpdate startUpdate)

Start a pipeline.

Starts a new update for the pipeline. If there is already an active update for the pipeline, the request will fail and the active update will remain running.

stop

void stop(StopRequest stopRequest)

Stop a pipeline.

Stops the pipeline by canceling the active update. If there is no active update for the pipeline, this request is a no-op.

update

void update(EditPipeline editPipeline)

Edit a pipeline.

Updates a pipeline with the supplied configuration.

updatePermissions

PipelinePermissions updatePermissions(PipelinePermissionsRequest pipelinePermissionsRequest)

Update pipeline permissions.

Updates the permissions on a pipeline. Pipelines can inherit permissions from their root object.