Package com.databricks.sdk.service.pipelines

Interface Summary

Interface	Description
PipelinesService	The Lakeflow Spark Declarative Pipelines API allows you to create, edit, delete, start, and view details about pipelines.

Class Summary

Class	Description
ApplyEnvironmentRequest
ApplyEnvironmentRequestResponse
AutoFullRefreshPolicy	Policy for auto full refresh.
ClonePipelineRequest
ClonePipelineResponse
ConfluenceConnectorOptions	Confluence specific options for ingestion
ConnectionParameters
ConnectorOptions	Wrapper message for source-specific options to support multiple connector types
CreatePipeline
CreatePipelineResponse
CronTrigger
DataPlaneId
DataStagingOptions	Location of staged data storage
DeletePipelineRequest
EditPipeline
ErrorDetail
EventLogSpec	Configurable event log parameters.
FileFilter
FileIngestionOptions
FileLibrary
Filters
GetPipelinePermissionLevelsRequest
GetPipelinePermissionLevelsResponse
GetPipelinePermissionsRequest
GetPipelineRequest
GetPipelineResponse
GetUpdateRequest
GetUpdateResponse
GoogleAdsConfig
GoogleAdsOptions	Google Ads specific options for ingestion (object-level).
GoogleDriveOptions
IngestionConfig
IngestionGatewayPipelineDefinition
IngestionPipelineDefinition
IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig	Configurations that are only applicable for query-based ingestion connectors.
IngestionPipelineDefinitionWorkdayReportParameters
IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue
JiraConnectorOptions	Jira specific options for ingestion
JsonTransformerOptions
KafkaOptions
ListPipelineEventsRequest
ListPipelineEventsResponse
ListPipelinesRequest
ListPipelinesResponse
ListUpdatesRequest
ListUpdatesResponse
ManualTrigger
MetaMarketingOptions	Meta Marketing (Meta Ads) specific options for ingestion
NotebookLibrary
Notifications
OperationTimeWindow	Proto representing a window
Origin
OutlookOptions	Outlook specific options for ingestion
PathPattern
PipelineAccessControlRequest
PipelineAccessControlResponse
PipelineCluster
PipelineClusterAutoscale
PipelineDeployment
PipelineEvent
PipelineLibrary
PipelinePermission
PipelinePermissions
PipelinePermissionsDescription
PipelinePermissionsRequest
PipelinesAPI	The Lakeflow Spark Declarative Pipelines API allows you to create, edit, delete, start, and view details about pipelines.
PipelinesEnvironment	The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines.
PipelineSpec
PipelineStateInfo
PipelineTrigger
PostgresCatalogConfig	PG-specific catalog-level configuration parameters
PostgresSlotConfig	PostgresSlotConfig contains the configuration for a Postgres logical replication slot
ReplaceWhereOverride	Specifies a replace_where predicate override for a replace where flow.
ReportSpec
RestartWindow
RewindDatasetSpec	Configuration for rewinding a specific dataset.
RewindSpec	Information about a rewind being requested for this pipeline or some of the datasets in it.
RunAs	Write-only setting, available only in Create/Update calls.
SchemaSpec
Sequencing
SerializedException
SharepointOptions
SmartsheetOptions	Smartsheet specific options for ingestion
SourceCatalogConfig	SourceCatalogConfig contains catalog-level custom configuration parameters for each source
SourceConfig
StackFrame
StartUpdate
StartUpdateResponse
StopRequest
TableSpec
TableSpecificConfig
TikTokAdsOptions	TikTok Ads specific options for ingestion
Transformer	Specifies how to transform binary data into structured data.
Truncation	Information about truncations applied to this event.
TruncationTruncationDetail	Details about a specific field that was truncated.
UpdateInfo
UpdateStateInfo
ZendeskSupportOptions	Zendesk Support specific options for ingestion

Enum Summary

Enum	Description
CloneMode	Enum to specify which mode of clone to execute
ConnectorType	For certain database sources LakeFlow Connect offers both query based and cdc ingestion, ConnectorType can bse used to convey the type of ingestion.
DayOfWeek	Days of week in which the window is allowed to happen.
DeploymentKind	The deployment method that manages the pipeline: - BUNDLE: The pipeline is managed by a Databricks Asset Bundle.
EventLevel	The severity level of the event.
FileIngestionOptionsFileFormat
FileIngestionOptionsSchemaEvolutionMode	Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work
GetPipelineResponseHealth	The health of a pipeline.
GoogleDriveOptionsGoogleDriveEntityType
IngestionSourceType
MaturityLevel	Maturity level for EventDetails.
OutlookAttachmentMode	Attachment behavior mode for Outlook ingestion
OutlookBodyFormat	Body format for Outlook email content
PipelineClusterAutoscaleMode	Databricks Enhanced Autoscaling optimizes cluster utilization by automatically allocating cluster resources based on workload volume, with minimal impact to the data processing latency of your pipelines.
PipelinePermissionLevel	Permission level
PipelineState	The pipeline state.
PipelineStateInfoHealth	The health of a pipeline.
PublishingMode	Enum representing the publishing mode of a pipeline.
SharepointOptionsSharepointEntityType
StartUpdateCause	What triggered this update.
TableSpecificConfigScdType	The SCD type to use to ingest the table.
TikTokAdsOptionsTikTokDataLevel	Data level for TikTok Ads report aggregation.
TikTokAdsOptionsTikTokReportType	Report type for TikTok Ads API.
TransformerFormat
UpdateInfoCause	What triggered this update.
UpdateInfoState	The update state.
UpdateStateInfoState	The update state.