com.databricks.sdk.service.pipelines.PipelinesService Maven / Gradle / Ivy
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.pipelines;
import com.databricks.sdk.support.Generated;
/**
* 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.
*/
@Generated
public interface PipelinesService {
/**
* 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.
*/
CreatePipelineResponse create(CreatePipeline createPipeline);
/**
* Delete a pipeline.
*
*
Deletes a pipeline.
*/
void delete(DeletePipelineRequest deletePipelineRequest);
/** Get a pipeline. */
GetPipelineResponse get(GetPipelineRequest getPipelineRequest);
/**
* Get pipeline permission levels.
*
*
Gets the permission levels that a user can have on an object.
*/
GetPipelinePermissionLevelsResponse getPermissionLevels(
GetPipelinePermissionLevelsRequest getPipelinePermissionLevelsRequest);
/**
* Get pipeline permissions.
*
*
Gets the permissions of a pipeline. Pipelines can inherit permissions from their root
* object.
*/
PipelinePermissions getPermissions(GetPipelinePermissionsRequest getPipelinePermissionsRequest);
/**
* Get a pipeline update.
*
*
Gets an update from an active pipeline.
*/
GetUpdateResponse getUpdate(GetUpdateRequest getUpdateRequest);
/**
* List pipeline events.
*
*
Retrieves events for a pipeline.
*/
ListPipelineEventsResponse listPipelineEvents(
ListPipelineEventsRequest listPipelineEventsRequest);
/**
* List pipelines.
*
*
Lists pipelines defined in the Delta Live Tables system.
*/
ListPipelinesResponse listPipelines(ListPipelinesRequest listPipelinesRequest);
/**
* List pipeline updates.
*
*
List updates for an active pipeline.
*/
ListUpdatesResponse listUpdates(ListUpdatesRequest listUpdatesRequest);
/**
* Set pipeline permissions.
*
*
Sets permissions on a pipeline. Pipelines can inherit permissions from their root object.
*/
PipelinePermissions setPermissions(PipelinePermissionsRequest pipelinePermissionsRequest);
/**
* 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.
*/
StartUpdateResponse startUpdate(StartUpdate startUpdate);
/**
* 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.
*/
void stop(StopRequest stopRequest);
/**
* Edit a pipeline.
*
*
Updates a pipeline with the supplied configuration.
*/
void update(EditPipeline editPipeline);
/**
* Update pipeline permissions.
*
*
Updates the permissions on a pipeline. Pipelines can inherit permissions from their root
* object.
*/
PipelinePermissions updatePermissions(PipelinePermissionsRequest pipelinePermissionsRequest);
}