@databricks/sdk-pipelines 0.0.0-dev → 0.1.0-dev.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2535 @@
1
+ import { z } from 'zod';
2
+ /** Enum to specify which mode of clone to execute */
3
+ export declare enum CloneMode {
4
+ /** Data and metadata are copied */
5
+ MIGRATE_TO_UC = "MIGRATE_TO_UC"
6
+ }
7
+ /**
8
+ * For certain database sources LakeFlow Connect offers both query based and cdc
9
+ * ingestion, ConnectorType can bse used to convey the type of ingestion.
10
+ * If connection_name is provided for database sources, we default to Query Based ingestion
11
+ */
12
+ export declare enum ConnectorType {
13
+ CONNECTOR_TYPE_UNSPECIFIED = "CONNECTOR_TYPE_UNSPECIFIED",
14
+ /**
15
+ * If connector_type = CDC and ingestion_gateway_id is provided then we use Ingestion Gateway pipeline with
16
+ * Cdc Managed Ingestion Pipeline for ingestion, if connector_type = CDC and connection_name is provided
17
+ * then we use Combined Cdc Managed Ingestion Pipeline.
18
+ */
19
+ CDC = "CDC",
20
+ QUERY_BASED = "QUERY_BASED"
21
+ }
22
+ /**
23
+ * Days of week in which the window is allowed to happen.
24
+ * If not specified all days of the week will be used.
25
+ */
26
+ export declare enum DayOfWeek {
27
+ DAY_OF_WEEK_UNSPECIFIED = "DAY_OF_WEEK_UNSPECIFIED",
28
+ MONDAY = "MONDAY",
29
+ TUESDAY = "TUESDAY",
30
+ WEDNESDAY = "WEDNESDAY",
31
+ THURSDAY = "THURSDAY",
32
+ FRIDAY = "FRIDAY",
33
+ SATURDAY = "SATURDAY",
34
+ SUNDAY = "SUNDAY"
35
+ }
36
+ /**
37
+ * The deployment method that manages the pipeline:
38
+ * - BUNDLE: The pipeline is managed by a Databricks Asset Bundle.
39
+ */
40
+ export declare enum DeploymentKind {
41
+ /** Databricks Asset Bundle (DAB) */
42
+ BUNDLE = "BUNDLE"
43
+ }
44
+ /** The severity level of the event. */
45
+ export declare enum EventLevel {
46
+ INFO = "INFO",
47
+ WARN = "WARN",
48
+ ERROR = "ERROR",
49
+ METRICS = "METRICS"
50
+ }
51
+ export declare enum IngestionSourceType {
52
+ INGESTION_SOURCE_TYPE_UNSPECIFIED = "INGESTION_SOURCE_TYPE_UNSPECIFIED",
53
+ MYSQL = "MYSQL",
54
+ POSTGRESQL = "POSTGRESQL",
55
+ SQLSERVER = "SQLSERVER",
56
+ SALESFORCE = "SALESFORCE",
57
+ BIGQUERY = "BIGQUERY",
58
+ NETSUITE = "NETSUITE",
59
+ WORKDAY_RAAS = "WORKDAY_RAAS",
60
+ GA4_RAW_DATA = "GA4_RAW_DATA",
61
+ SERVICENOW = "SERVICENOW",
62
+ MANAGED_POSTGRESQL = "MANAGED_POSTGRESQL",
63
+ ORACLE = "ORACLE",
64
+ TERADATA = "TERADATA",
65
+ SHAREPOINT = "SHAREPOINT",
66
+ DYNAMICS365 = "DYNAMICS365",
67
+ GOOGLE_DRIVE = "GOOGLE_DRIVE",
68
+ JIRA = "JIRA",
69
+ CONFLUENCE = "CONFLUENCE",
70
+ META_MARKETING = "META_MARKETING",
71
+ ZENDESK = "ZENDESK",
72
+ FOREIGN_CATALOG = "FOREIGN_CATALOG"
73
+ }
74
+ /** Maturity level for EventDetails. */
75
+ export declare enum MaturityLevel {
76
+ STABLE = "STABLE",
77
+ EVOLVING = "EVOLVING",
78
+ DEPRECATED = "DEPRECATED"
79
+ }
80
+ /** Attachment behavior mode for Outlook ingestion */
81
+ export declare enum OutlookAttachmentMode {
82
+ OUTLOOK_ATTACHMENT_MODE_UNSPECIFIED = "OUTLOOK_ATTACHMENT_MODE_UNSPECIFIED",
83
+ /** Ingest all attachments (both inline and non-inline) */
84
+ ALL = "ALL",
85
+ /** Ingest only non-inline attachments (recommended to avoid corporate signature images) */
86
+ NON_INLINE_ONLY = "NON_INLINE_ONLY",
87
+ /** Ingest only inline attachments */
88
+ INLINE_ONLY = "INLINE_ONLY",
89
+ /** Do not ingest any attachments */
90
+ NONE = "NONE"
91
+ }
92
+ /** Body format for Outlook email content */
93
+ export declare enum OutlookBodyFormat {
94
+ OUTLOOK_BODY_FORMAT_UNSPECIFIED = "OUTLOOK_BODY_FORMAT_UNSPECIFIED",
95
+ TEXT_HTML = "TEXT_HTML",
96
+ TEXT_PLAIN = "TEXT_PLAIN"
97
+ }
98
+ /** The health of a pipeline. */
99
+ export declare enum PipelineHealthStatus {
100
+ HEALTHY = "HEALTHY",
101
+ UNHEALTHY = "UNHEALTHY"
102
+ }
103
+ /** The set of AWS availability types supported when setting up nodes for a cluster. */
104
+ export declare enum PipelinesAwsAvailability {
105
+ /** Use spot instances. */
106
+ SPOT = "SPOT",
107
+ /** Use on-demand instances. */
108
+ ON_DEMAND = "ON_DEMAND",
109
+ /**
110
+ * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
111
+ * be acquired (e.g., if AWS spot prices are too high).
112
+ */
113
+ SPOT_WITH_FALLBACK = "SPOT_WITH_FALLBACK"
114
+ }
115
+ /** The set of Azure availability types supported when setting up nodes for a cluster. */
116
+ export declare enum PipelinesAzureAvailability {
117
+ /** Use spot instances. */
118
+ SPOT_AZURE = "SPOT_AZURE",
119
+ /** Use on-demand instances. */
120
+ ON_DEMAND_AZURE = "ON_DEMAND_AZURE",
121
+ /**
122
+ * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
123
+ * be acquired (e.g., if Azure is out of Quota).
124
+ */
125
+ SPOT_WITH_FALLBACK_AZURE = "SPOT_WITH_FALLBACK_AZURE"
126
+ }
127
+ /**
128
+ * All EBS volume types that <Databricks> supports.
129
+ * See https://aws.amazon.com/ebs/details/ for details.
130
+ */
131
+ export declare enum PipelinesEbsVolumeType {
132
+ /** Provision extra storage using AWS gp2 EBS volumes. */
133
+ GENERAL_PURPOSE_SSD = "GENERAL_PURPOSE_SSD",
134
+ /** Provision extra storage using AWS st1 volumes. */
135
+ THROUGHPUT_OPTIMIZED_HDD = "THROUGHPUT_OPTIMIZED_HDD"
136
+ }
137
+ /** The set of GCP availability types supported when setting up nodes for a cluster (configurable only for executors). */
138
+ export declare enum PipelinesGcpAvailability {
139
+ PREEMPTIBLE_GCP = "PREEMPTIBLE_GCP",
140
+ ON_DEMAND_GCP = "ON_DEMAND_GCP",
141
+ PREEMPTIBLE_WITH_FALLBACK_GCP = "PREEMPTIBLE_WITH_FALLBACK_GCP"
142
+ }
143
+ /** Enum representing the publishing mode of a pipeline. */
144
+ export declare enum PublishingMode {
145
+ PUBLISHING_MODE_UNSPECIFIED = "PUBLISHING_MODE_UNSPECIFIED",
146
+ LEGACY_PUBLISHING_MODE = "LEGACY_PUBLISHING_MODE",
147
+ DEFAULT_PUBLISHING_MODE = "DEFAULT_PUBLISHING_MODE"
148
+ }
149
+ /** What triggered this update. */
150
+ export declare enum UpdateCause {
151
+ /** Started through an API call. */
152
+ API_CALL = "API_CALL",
153
+ /** Started as a retry for a failed update. */
154
+ RETRY_ON_FAILURE = "RETRY_ON_FAILURE",
155
+ /** Started as a result of a service upgrade. */
156
+ SERVICE_UPGRADE = "SERVICE_UPGRADE",
157
+ /** Started as a result of a schema change. */
158
+ SCHEMA_CHANGE = "SCHEMA_CHANGE",
159
+ /** Started by the Jobs service. */
160
+ JOB_TASK = "JOB_TASK",
161
+ /** Started by an action a user performed. */
162
+ USER_ACTION = "USER_ACTION",
163
+ /** Started for infrastructure maintenance reason. */
164
+ INFRASTRUCTURE_MAINTENANCE = "INFRASTRUCTURE_MAINTENANCE"
165
+ }
166
+ /** The update state. */
167
+ export declare enum UpdateState {
168
+ /** Update is waiting for previous update to finish. */
169
+ QUEUED = "QUEUED",
170
+ /** Initial state of an update. */
171
+ CREATED = "CREATED",
172
+ /** Update is waiting for clusters, jobs, or other resources. */
173
+ WAITING_FOR_RESOURCES = "WAITING_FOR_RESOURCES",
174
+ /** Update is creating the dataflow graph. */
175
+ INITIALIZING = "INITIALIZING",
176
+ /** Update is resetting datasets and checkpoints to the beginning. */
177
+ RESETTING = "RESETTING",
178
+ /** If necessary, Update is creating tables or updating their schemas. */
179
+ SETTING_UP_TABLES = "SETTING_UP_TABLES",
180
+ /** Update is currently executing queries. */
181
+ RUNNING = "RUNNING",
182
+ /** Update is waiting for queries to shut down. */
183
+ STOPPING = "STOPPING",
184
+ /** Update is complete and all necessary resources are cleaned up. */
185
+ COMPLETED = "COMPLETED",
186
+ /** Update has run into an error that could not be recovered from. */
187
+ FAILED = "FAILED",
188
+ /** Update was canceled while it was running or queued. */
189
+ CANCELED = "CANCELED"
190
+ }
191
+ export declare enum FileIngestionOptions_FileFormat {
192
+ FILE_FORMAT_UNSPECIFIED = "FILE_FORMAT_UNSPECIFIED",
193
+ BINARYFILE = "BINARYFILE",
194
+ JSON = "JSON",
195
+ CSV = "CSV",
196
+ XML = "XML",
197
+ EXCEL = "EXCEL",
198
+ PARQUET = "PARQUET",
199
+ AVRO = "AVRO",
200
+ ORC = "ORC"
201
+ }
202
+ /** Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work */
203
+ export declare enum FileIngestionOptions_SchemaEvolutionMode {
204
+ SCHEMA_EVOLUTION_MODE_UNSPECIFIED = "SCHEMA_EVOLUTION_MODE_UNSPECIFIED",
205
+ ADD_NEW_COLUMNS_WITH_TYPE_WIDENING = "ADD_NEW_COLUMNS_WITH_TYPE_WIDENING",
206
+ ADD_NEW_COLUMNS = "ADD_NEW_COLUMNS",
207
+ RESCUE = "RESCUE",
208
+ FAIL_ON_NEW_COLUMNS = "FAIL_ON_NEW_COLUMNS",
209
+ NONE = "NONE"
210
+ }
211
+ export declare enum GoogleDriveOptions_GoogleDriveEntityType {
212
+ GOOGLE_DRIVE_ENTITY_TYPE_UNSPECIFIED = "GOOGLE_DRIVE_ENTITY_TYPE_UNSPECIFIED",
213
+ FILE = "FILE",
214
+ FILE_METADATA = "FILE_METADATA",
215
+ PERMISSION = "PERMISSION"
216
+ }
217
+ /** The pipeline state. */
218
+ export declare enum PipelineState_PipelineState {
219
+ /** Pipeline is being deployed and waiting for clusters, jobs, or other resources */
220
+ DEPLOYING = "DEPLOYING",
221
+ /** Pipeline is deployed but waiting for streams to start and make progress */
222
+ STARTING = "STARTING",
223
+ /** Pipeline is currently executing */
224
+ RUNNING = "RUNNING",
225
+ /** Pipeline is waiting for streams to shut down */
226
+ STOPPING = "STOPPING",
227
+ /** All clusters, jobs, and other resources associated with the pipeline have been cleaned up */
228
+ DELETED = "DELETED",
229
+ /** Pipeline has run into an error, but the daemon is attempting to fix it */
230
+ RECOVERING = "RECOVERING",
231
+ /** Pipeline has run into an error that could not be recovered from */
232
+ FAILED = "FAILED",
233
+ /** Pipeline is currently being reset */
234
+ RESETTING = "RESETTING",
235
+ /** Pipeline is stopped and is not processing data. Can be resumed by calling `run` */
236
+ IDLE = "IDLE"
237
+ }
238
+ /** The SCD type to use to ingest the table. */
239
+ export declare enum ScdType_ScdType {
240
+ SCD_TYPE_UNSPECIFIED = "SCD_TYPE_UNSPECIFIED",
241
+ SCD_TYPE_1 = "SCD_TYPE_1",
242
+ SCD_TYPE_2 = "SCD_TYPE_2",
243
+ /**
244
+ * Source data will be appended to destination table rather than merged in
245
+ * the absence of row key.
246
+ */
247
+ APPEND_ONLY = "APPEND_ONLY"
248
+ }
249
+ export declare enum SharepointOptions_SharepointEntityType {
250
+ SHAREPOINT_ENTITY_TYPE_UNSPECIFIED = "SHAREPOINT_ENTITY_TYPE_UNSPECIFIED",
251
+ FILE = "FILE",
252
+ FILE_METADATA = "FILE_METADATA",
253
+ PERMISSION = "PERMISSION",
254
+ LIST = "LIST"
255
+ }
256
+ /** Data level for TikTok Ads report aggregation. */
257
+ export declare enum TikTokAdsOptions_TikTokDataLevel {
258
+ TIK_TOK_DATA_LEVEL_UNSPECIFIED = "TIK_TOK_DATA_LEVEL_UNSPECIFIED",
259
+ AUCTION_ADVERTISER = "AUCTION_ADVERTISER",
260
+ AUCTION_CAMPAIGN = "AUCTION_CAMPAIGN",
261
+ AUCTION_ADGROUP = "AUCTION_ADGROUP",
262
+ AUCTION_AD = "AUCTION_AD"
263
+ }
264
+ /** Report type for TikTok Ads API. */
265
+ export declare enum TikTokAdsOptions_TikTokReportType {
266
+ TIK_TOK_REPORT_TYPE_UNSPECIFIED = "TIK_TOK_REPORT_TYPE_UNSPECIFIED",
267
+ BASIC = "BASIC",
268
+ AUDIENCE = "AUDIENCE",
269
+ PLAYABLE_AD = "PLAYABLE_AD",
270
+ DSA = "DSA",
271
+ BUSINESS_CENTER = "BUSINESS_CENTER",
272
+ GMV_MAX = "GMV_MAX"
273
+ }
274
+ export declare enum Transformer_Format {
275
+ FORMAT_UNSPECIFIED = "FORMAT_UNSPECIFIED",
276
+ STRING = "STRING",
277
+ JSON = "JSON"
278
+ }
279
+ export interface ApplyEnvironmentRequest {
280
+ pipelineId?: string | undefined;
281
+ }
282
+ export interface ApplyEnvironmentRequest_Response {
283
+ }
284
+ /** Policy for auto full refresh. */
285
+ export interface AutoFullRefreshPolicy {
286
+ /** (Required, Mutable) Whether to enable auto full refresh or not. */
287
+ enabled?: boolean | undefined;
288
+ /**
289
+ * (Optional, Mutable) Specify the minimum interval in hours between the timestamp
290
+ * at which a table was last full refreshed and the current timestamp for triggering auto full
291
+ * If unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours.
292
+ */
293
+ minIntervalHours?: number | undefined;
294
+ }
295
+ export interface ClonePipelineRequest {
296
+ /** Source pipeline to clone from */
297
+ pipelineId?: string | undefined;
298
+ /**
299
+ * If present, the last-modified time of the pipeline settings before the clone.
300
+ * If the settings were modified after that time, then the request will fail with
301
+ * a conflict.
302
+ */
303
+ expectedLastModified?: bigint | undefined;
304
+ /** If false, deployment will fail if name conflicts with that of another pipeline. */
305
+ allowDuplicateNames?: boolean | undefined;
306
+ /** Unique identifier for this pipeline. */
307
+ id?: string | undefined;
308
+ /** Friendly identifier for this pipeline. */
309
+ name?: string | undefined;
310
+ /** DBFS root directory for storing checkpoints and tables. */
311
+ storage?: string | undefined;
312
+ /** String-String configuration for this pipeline execution. */
313
+ configuration?: Record<string, string> | undefined;
314
+ /** Cluster settings for this pipeline deployment. */
315
+ clusters?: PipelineCluster[] | undefined;
316
+ /** Libraries or code needed by this deployment. */
317
+ libraries?: PipelineLibrary[] | undefined;
318
+ /** The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. */
319
+ ingestionDefinition?: IngestionPipelineDefinition | undefined;
320
+ /** The definition of a gateway pipeline to support change data capture. */
321
+ gatewayDefinition?: IngestionGatewayPipelineDefinition | undefined;
322
+ /** Which pipeline trigger to use. Deprecated: Use `continuous` instead. */
323
+ trigger?: PipelineTrigger | undefined;
324
+ /** Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field. */
325
+ target?: string | undefined;
326
+ /** The default schema (database) where tables are read from or published to. */
327
+ schema?: string | undefined;
328
+ /** Filters on which Pipeline packages to include in the deployed graph. */
329
+ filters?: Filters | undefined;
330
+ /** Whether the pipeline is continuous or triggered. This replaces `trigger`. */
331
+ continuous?: boolean | undefined;
332
+ /** Whether the pipeline is in Development mode. Defaults to false. */
333
+ development?: boolean | undefined;
334
+ /** Whether Photon is enabled for this pipeline. */
335
+ photon?: boolean | undefined;
336
+ /** Pipeline product edition. */
337
+ edition?: string | undefined;
338
+ /** SDP Release Channel that specifies which version to use. */
339
+ channel?: string | undefined;
340
+ /** A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog. */
341
+ catalog?: string | undefined;
342
+ /** List of notification settings for this pipeline. */
343
+ notifications?: Notifications[] | undefined;
344
+ /** Whether serverless compute is enabled for this pipeline. */
345
+ serverless?: boolean | undefined;
346
+ /** Deployment type of this pipeline. */
347
+ deployment?: PipelineDeployment | undefined;
348
+ /** Restart window of this pipeline. */
349
+ restartWindow?: RestartWindow | undefined;
350
+ /** Budget policy of this pipeline. */
351
+ budgetPolicyId?: string | undefined;
352
+ /**
353
+ * A map of tags associated with the pipeline.
354
+ * These are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.
355
+ * A maximum of 25 tags can be added to the pipeline.
356
+ */
357
+ tags?: Record<string, string> | undefined;
358
+ /** Event log configuration for this pipeline */
359
+ eventLog?: EventLogSpec | undefined;
360
+ /**
361
+ * Root path for this pipeline.
362
+ * This is used as the root directory when editing the pipeline in the <Databricks> user interface and it is
363
+ * added to sys.path when executing Python sources during pipeline execution.
364
+ */
365
+ rootPath?: string | undefined;
366
+ /** Environment specification for this pipeline used to install dependencies. */
367
+ environment?: PipelinesEnvironment | undefined;
368
+ /** Usage policy of this pipeline. */
369
+ usagePolicyId?: string | undefined;
370
+ /** The type of clone to perform. Currently, only deep copies are supported */
371
+ cloneMode?: CloneMode | undefined;
372
+ }
373
+ /** Key value pair used to specify configuration parameters to Execution */
374
+ export interface ClonePipelineRequest_ConfigurationEntry {
375
+ key?: string | undefined;
376
+ value?: string | undefined;
377
+ }
378
+ export interface ClonePipelineRequest_Response {
379
+ /** The pipeline id of the cloned pipeline */
380
+ pipelineId?: string | undefined;
381
+ }
382
+ /** A key-value entry that defines a single pipeline tags. */
383
+ export interface ClonePipelineRequest_TagsEntry {
384
+ /** Mandatory key for the tag pair. */
385
+ key?: string | undefined;
386
+ /**
387
+ * Optional value to be associated with the provided key.
388
+ * If the value is not provided, the key serves as the sole identifier of this key-value pair and the values is assumed to be an empty string.
389
+ */
390
+ value?: string | undefined;
391
+ }
392
+ /** Confluence specific options for ingestion */
393
+ export interface ConfluenceConnectorOptions {
394
+ /** (Optional) Spaces to filter Confluence data on */
395
+ includeConfluenceSpaces?: string[] | undefined;
396
+ }
397
+ export interface ConnectionParameters {
398
+ /**
399
+ * Source catalog for initial connection.
400
+ * This is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have
401
+ * in some other database systems like Postgres.
402
+ * For Oracle databases, this maps to a service name.
403
+ */
404
+ sourceCatalog?: string | undefined;
405
+ }
406
+ /** Wrapper message for source-specific options to support multiple connector types */
407
+ export interface ConnectorOptions {
408
+ connectorOptions?: {
409
+ $case: 'googleAdsOptions';
410
+ googleAdsOptions: GoogleAdsOptions;
411
+ } | {
412
+ $case: 'tiktokAdsOptions';
413
+ tiktokAdsOptions: TikTokAdsOptions;
414
+ } | {
415
+ $case: 'sharepointOptions';
416
+ sharepointOptions: SharepointOptions;
417
+ } | {
418
+ $case: 'gdriveOptions';
419
+ gdriveOptions: GoogleDriveOptions;
420
+ } | {
421
+ $case: 'outlookOptions';
422
+ outlookOptions: OutlookOptions;
423
+ } | {
424
+ $case: 'smartsheetOptions';
425
+ smartsheetOptions: SmartsheetOptions;
426
+ } | {
427
+ $case: 'jiraOptions';
428
+ jiraOptions: JiraConnectorOptions;
429
+ } | {
430
+ $case: 'confluenceOptions';
431
+ confluenceOptions: ConfluenceConnectorOptions;
432
+ } | {
433
+ $case: 'metaAdsOptions';
434
+ metaAdsOptions: MetaMarketingOptions;
435
+ } | {
436
+ $case: 'zendeskSupportOptions';
437
+ zendeskSupportOptions: ZendeskSupportOptions;
438
+ } | {
439
+ $case: 'kafkaOptions';
440
+ kafkaOptions: KafkaOptions;
441
+ } | undefined;
442
+ }
443
+ export interface CreatePipelineRequest {
444
+ /** If false, deployment will fail if name conflicts with that of another pipeline. */
445
+ allowDuplicateNames?: boolean | undefined;
446
+ dryRun?: boolean | undefined;
447
+ runAs?: PipelinesJobRunAs | undefined;
448
+ /**
449
+ * Key/value map of default parameters to use for pipeline execution.
450
+ * Maximum total size: 10k characters (JSON format)
451
+ */
452
+ parameters?: Record<string, string> | undefined;
453
+ /** Unique identifier for this pipeline. */
454
+ id?: string | undefined;
455
+ /** Friendly identifier for this pipeline. */
456
+ name?: string | undefined;
457
+ /** DBFS root directory for storing checkpoints and tables. */
458
+ storage?: string | undefined;
459
+ /** String-String configuration for this pipeline execution. */
460
+ configuration?: Record<string, string> | undefined;
461
+ /** Cluster settings for this pipeline deployment. */
462
+ clusters?: PipelineCluster[] | undefined;
463
+ /** Libraries or code needed by this deployment. */
464
+ libraries?: PipelineLibrary[] | undefined;
465
+ /** The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. */
466
+ ingestionDefinition?: IngestionPipelineDefinition | undefined;
467
+ /** The definition of a gateway pipeline to support change data capture. */
468
+ gatewayDefinition?: IngestionGatewayPipelineDefinition | undefined;
469
+ /** Which pipeline trigger to use. Deprecated: Use `continuous` instead. */
470
+ trigger?: PipelineTrigger | undefined;
471
+ /** Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field. */
472
+ target?: string | undefined;
473
+ /** The default schema (database) where tables are read from or published to. */
474
+ schema?: string | undefined;
475
+ /** Filters on which Pipeline packages to include in the deployed graph. */
476
+ filters?: Filters | undefined;
477
+ /** Whether the pipeline is continuous or triggered. This replaces `trigger`. */
478
+ continuous?: boolean | undefined;
479
+ /** Whether the pipeline is in Development mode. Defaults to false. */
480
+ development?: boolean | undefined;
481
+ /** Whether Photon is enabled for this pipeline. */
482
+ photon?: boolean | undefined;
483
+ /** Pipeline product edition. */
484
+ edition?: string | undefined;
485
+ /** SDP Release Channel that specifies which version to use. */
486
+ channel?: string | undefined;
487
+ /** A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog. */
488
+ catalog?: string | undefined;
489
+ /** List of notification settings for this pipeline. */
490
+ notifications?: Notifications[] | undefined;
491
+ /** Whether serverless compute is enabled for this pipeline. */
492
+ serverless?: boolean | undefined;
493
+ /** Deployment type of this pipeline. */
494
+ deployment?: PipelineDeployment | undefined;
495
+ /** Restart window of this pipeline. */
496
+ restartWindow?: RestartWindow | undefined;
497
+ /** Budget policy of this pipeline. */
498
+ budgetPolicyId?: string | undefined;
499
+ /**
500
+ * A map of tags associated with the pipeline.
501
+ * These are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.
502
+ * A maximum of 25 tags can be added to the pipeline.
503
+ */
504
+ tags?: Record<string, string> | undefined;
505
+ /** Event log configuration for this pipeline */
506
+ eventLog?: EventLogSpec | undefined;
507
+ /**
508
+ * Root path for this pipeline.
509
+ * This is used as the root directory when editing the pipeline in the <Databricks> user interface and it is
510
+ * added to sys.path when executing Python sources during pipeline execution.
511
+ */
512
+ rootPath?: string | undefined;
513
+ /** Environment specification for this pipeline used to install dependencies. */
514
+ environment?: PipelinesEnvironment | undefined;
515
+ /** Usage policy of this pipeline. */
516
+ usagePolicyId?: string | undefined;
517
+ }
518
+ /** Key value pair used to specify configuration parameters to Execution */
519
+ export interface CreatePipelineRequest_ConfigurationEntry {
520
+ key?: string | undefined;
521
+ value?: string | undefined;
522
+ }
523
+ export interface CreatePipelineRequest_ParametersEntry {
524
+ key?: string | undefined;
525
+ value?: string | undefined;
526
+ }
527
+ export interface CreatePipelineRequest_Response {
528
+ /** The unique identifier for the newly created pipeline. Only returned when dry_run is false. */
529
+ pipelineId?: string | undefined;
530
+ /** Only returned when dry_run is true. */
531
+ effectiveSettings?: PipelineSpec | undefined;
532
+ }
533
+ /** A key-value entry that defines a single pipeline tags. */
534
+ export interface CreatePipelineRequest_TagsEntry {
535
+ /** Mandatory key for the tag pair. */
536
+ key?: string | undefined;
537
+ /**
538
+ * Optional value to be associated with the provided key.
539
+ * If the value is not provided, the key serves as the sole identifier of this key-value pair and the values is assumed to be an empty string.
540
+ */
541
+ value?: string | undefined;
542
+ }
543
+ export interface CronTrigger {
544
+ quartzCronSchedule?: string | undefined;
545
+ timezoneId?: string | undefined;
546
+ }
547
+ export interface DataPlaneId {
548
+ /** The instance name of the data plane emitting an event. */
549
+ instance?: string | undefined;
550
+ /** A sequence number, unique and increasing within the data plane instance. */
551
+ seqNo?: bigint | undefined;
552
+ }
553
+ /** Location of staged data storage */
554
+ export interface DataStagingOptions {
555
+ /** (Required, Immutable) The name of the catalog for the connector's staging storage location. */
556
+ catalogName?: string | undefined;
557
+ /** (Required, Immutable) The name of the schema for the connector's staging storage location. */
558
+ schemaName?: string | undefined;
559
+ /**
560
+ * (Optional) The Unity Catalog-compatible name for the storage location.
561
+ * This is the volume to use for the data that is extracted by the connector.
562
+ * Spark Declarative Pipelines system will automatically create the volume under the catalog and schema.
563
+ * For Combined Cdc Managed Ingestion pipelines default name for the volume would be :
564
+ * __databricks_ingestion_gateway_staging_data-$pipelineId
565
+ */
566
+ volumeName?: string | undefined;
567
+ }
568
+ export interface DeletePipelineRequest {
569
+ pipelineId?: string | undefined;
570
+ /**
571
+ * If true, deletion will proceed even if resource cleanup fails.
572
+ * By default, deletion will fail if resources cleanup is required but fails.
573
+ */
574
+ force?: boolean | undefined;
575
+ /**
576
+ * If false, pipeline deletion will not cascade to its datasets (MVs, STs, Views).
577
+ * By default, this parameter will be true and all tables will be deleted with the pipeline.
578
+ */
579
+ cascade?: boolean | undefined;
580
+ }
581
+ export interface DeletePipelineRequest_Response {
582
+ }
583
+ export interface EditPipelineRequest {
584
+ /** Unique identifier for this pipeline. */
585
+ pipelineId?: string | undefined;
586
+ /** If false, deployment will fail if name has changed and conflicts the name of another pipeline. */
587
+ allowDuplicateNames?: boolean | undefined;
588
+ /**
589
+ * If present, the last-modified time of the pipeline settings before the edit.
590
+ * If the settings were modified after that time, then the request will fail with
591
+ * a conflict.
592
+ */
593
+ expectedLastModified?: bigint | undefined;
594
+ runAs?: PipelinesJobRunAs | undefined;
595
+ /**
596
+ * Key/value map of default parameters to use for pipeline execution.
597
+ * Maximum total size: 10k characters (JSON format)
598
+ */
599
+ parameters?: Record<string, string> | undefined;
600
+ /** Unique identifier for this pipeline. */
601
+ id?: string | undefined;
602
+ /** Friendly identifier for this pipeline. */
603
+ name?: string | undefined;
604
+ /** DBFS root directory for storing checkpoints and tables. */
605
+ storage?: string | undefined;
606
+ /** String-String configuration for this pipeline execution. */
607
+ configuration?: Record<string, string> | undefined;
608
+ /** Cluster settings for this pipeline deployment. */
609
+ clusters?: PipelineCluster[] | undefined;
610
+ /** Libraries or code needed by this deployment. */
611
+ libraries?: PipelineLibrary[] | undefined;
612
+ /** The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. */
613
+ ingestionDefinition?: IngestionPipelineDefinition | undefined;
614
+ /** The definition of a gateway pipeline to support change data capture. */
615
+ gatewayDefinition?: IngestionGatewayPipelineDefinition | undefined;
616
+ /** Which pipeline trigger to use. Deprecated: Use `continuous` instead. */
617
+ trigger?: PipelineTrigger | undefined;
618
+ /** Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field. */
619
+ target?: string | undefined;
620
+ /** The default schema (database) where tables are read from or published to. */
621
+ schema?: string | undefined;
622
+ /** Filters on which Pipeline packages to include in the deployed graph. */
623
+ filters?: Filters | undefined;
624
+ /** Whether the pipeline is continuous or triggered. This replaces `trigger`. */
625
+ continuous?: boolean | undefined;
626
+ /** Whether the pipeline is in Development mode. Defaults to false. */
627
+ development?: boolean | undefined;
628
+ /** Whether Photon is enabled for this pipeline. */
629
+ photon?: boolean | undefined;
630
+ /** Pipeline product edition. */
631
+ edition?: string | undefined;
632
+ /** SDP Release Channel that specifies which version to use. */
633
+ channel?: string | undefined;
634
+ /** A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog. */
635
+ catalog?: string | undefined;
636
+ /** List of notification settings for this pipeline. */
637
+ notifications?: Notifications[] | undefined;
638
+ /** Whether serverless compute is enabled for this pipeline. */
639
+ serverless?: boolean | undefined;
640
+ /** Deployment type of this pipeline. */
641
+ deployment?: PipelineDeployment | undefined;
642
+ /** Restart window of this pipeline. */
643
+ restartWindow?: RestartWindow | undefined;
644
+ /** Budget policy of this pipeline. */
645
+ budgetPolicyId?: string | undefined;
646
+ /**
647
+ * A map of tags associated with the pipeline.
648
+ * These are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.
649
+ * A maximum of 25 tags can be added to the pipeline.
650
+ */
651
+ tags?: Record<string, string> | undefined;
652
+ /** Event log configuration for this pipeline */
653
+ eventLog?: EventLogSpec | undefined;
654
+ /**
655
+ * Root path for this pipeline.
656
+ * This is used as the root directory when editing the pipeline in the <Databricks> user interface and it is
657
+ * added to sys.path when executing Python sources during pipeline execution.
658
+ */
659
+ rootPath?: string | undefined;
660
+ /** Environment specification for this pipeline used to install dependencies. */
661
+ environment?: PipelinesEnvironment | undefined;
662
+ /** Usage policy of this pipeline. */
663
+ usagePolicyId?: string | undefined;
664
+ }
665
+ /** Key value pair used to specify configuration parameters to Execution */
666
+ export interface EditPipelineRequest_ConfigurationEntry {
667
+ key?: string | undefined;
668
+ value?: string | undefined;
669
+ }
670
+ export interface EditPipelineRequest_ParametersEntry {
671
+ key?: string | undefined;
672
+ value?: string | undefined;
673
+ }
674
+ export interface EditPipelineRequest_Response {
675
+ }
676
+ /** A key-value entry that defines a single pipeline tags. */
677
+ export interface EditPipelineRequest_TagsEntry {
678
+ /** Mandatory key for the tag pair. */
679
+ key?: string | undefined;
680
+ /**
681
+ * Optional value to be associated with the provided key.
682
+ * If the value is not provided, the key serves as the sole identifier of this key-value pair and the values is assumed to be an empty string.
683
+ */
684
+ value?: string | undefined;
685
+ }
686
+ export interface ErrorDetail {
687
+ /** The exception thrown for this error, with its chain of cause. */
688
+ exceptions?: SerializedException[] | undefined;
689
+ /** Whether this error is considered fatal, that is, unrecoverable. */
690
+ fatal?: boolean | undefined;
691
+ }
692
+ /** Configurable event log parameters. */
693
+ export interface EventLogSpec {
694
+ /** The name the event log is published to in UC. */
695
+ name?: string | undefined;
696
+ /** The UC schema the event log is published under. */
697
+ schema?: string | undefined;
698
+ /** The UC catalog the event log is published under. */
699
+ catalog?: string | undefined;
700
+ }
701
+ export interface FileFilter {
702
+ filter?: {
703
+ $case: 'pathFilter';
704
+ /**
705
+ * Include files with file names matching the pattern
706
+ * Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter
707
+ */
708
+ pathFilter: string;
709
+ } | {
710
+ $case: 'modifiedBefore';
711
+ /**
712
+ * Include files with modification times occurring before the specified time.
713
+ * Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)
714
+ * Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters
715
+ */
716
+ modifiedBefore: string;
717
+ } | {
718
+ $case: 'modifiedAfter';
719
+ /**
720
+ * Include files with modification times occurring after the specified time.
721
+ * Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)
722
+ * Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters
723
+ */
724
+ modifiedAfter: string;
725
+ } | undefined;
726
+ }
727
+ export interface FileIngestionOptions {
728
+ /** required for TableSpec */
729
+ format?: FileIngestionOptions_FileFormat | undefined;
730
+ /** Generic options */
731
+ fileFilters?: FileFilter[] | undefined;
732
+ inferColumnTypes?: boolean | undefined;
733
+ schemaEvolutionMode?: FileIngestionOptions_SchemaEvolutionMode | undefined;
734
+ /**
735
+ * Override inferred schema of specific columns
736
+ * Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints
737
+ */
738
+ schemaHints?: string | undefined;
739
+ ignoreCorruptFiles?: boolean | undefined;
740
+ corruptRecordColumn?: string | undefined;
741
+ rescuedDataColumn?: string | undefined;
742
+ singleVariantColumn?: string | undefined;
743
+ /**
744
+ * Column name case sensitivity
745
+ * https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior
746
+ */
747
+ readerCaseSensitive?: boolean | undefined;
748
+ /**
749
+ * Format-specific options
750
+ * Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options
751
+ */
752
+ formatOptions?: Record<string, string> | undefined;
753
+ }
754
+ /**
755
+ * Key value pair used to specify configuration parameters
756
+ * Based on public doc https://docs.databricks.com/en/ingestion/auto-loader/options.html
757
+ */
758
+ export interface FileIngestionOptions_FormatOptionsEntry {
759
+ key?: string | undefined;
760
+ value?: string | undefined;
761
+ }
762
+ export interface Filters {
763
+ /** Paths to include. */
764
+ include?: string[] | undefined;
765
+ /** Paths to exclude. */
766
+ exclude?: string[] | undefined;
767
+ }
768
+ export interface GetPipelineRequest {
769
+ pipelineId?: string | undefined;
770
+ }
771
+ export interface GetPipelineRequest_Response {
772
+ /** The ID of the pipeline. */
773
+ pipelineId?: string | undefined;
774
+ /** The pipeline specification. This field is not returned when called by `ListPipelines`. */
775
+ spec?: PipelineSpec | undefined;
776
+ /** The pipeline state. */
777
+ state?: PipelineState_PipelineState | undefined;
778
+ /** An optional message detailing the cause of the pipeline state. */
779
+ cause?: string | undefined;
780
+ /** The ID of the cluster that the pipeline is running on. */
781
+ clusterId?: string | undefined;
782
+ /** A human friendly identifier for the pipeline, taken from the `spec`. */
783
+ name?: string | undefined;
784
+ /** The health of a pipeline. */
785
+ health?: PipelineHealthStatus | undefined;
786
+ /** The username of the pipeline creator. */
787
+ creatorUserName?: string | undefined;
788
+ /** Status of the latest updates for the pipeline. Ordered with the newest update first. */
789
+ latestUpdates?: UpdateStateInfo[] | undefined;
790
+ /** The last time the pipeline settings were modified or created. */
791
+ lastModified?: bigint | undefined;
792
+ /** Username of the user that the pipeline will run on behalf of. */
793
+ runAsUserName?: string | undefined;
794
+ /** Serverless budget policy ID of this pipeline. */
795
+ effectiveBudgetPolicyId?: string | undefined;
796
+ /** Publishing mode of the pipeline */
797
+ effectivePublishingMode?: PublishingMode | undefined;
798
+ /**
799
+ * The user or service principal that the pipeline runs as, if specified in the request.
800
+ * This field indicates the explicit configuration of `run_as` for the pipeline.
801
+ * To find the value in all cases, explicit or implicit, use `run_as_user_name`.
802
+ */
803
+ runAs?: PipelinesJobRunAs | undefined;
804
+ /**
805
+ * Key/value map of default parameters to use for pipeline execution.
806
+ * Maximum total size: 10k characters (JSON format)
807
+ */
808
+ parameters?: Record<string, string> | undefined;
809
+ }
810
+ export interface GetPipelineRequest_Response_ParametersEntry {
811
+ key?: string | undefined;
812
+ value?: string | undefined;
813
+ }
814
+ export interface GetUpdateRequest {
815
+ /** The ID of the pipeline. */
816
+ pipelineId?: string | undefined;
817
+ /** The ID of the update. */
818
+ updateId?: string | undefined;
819
+ }
820
+ export interface GetUpdateRequest_Response {
821
+ /** The current update info. */
822
+ update?: UpdateInfo | undefined;
823
+ }
824
+ export interface GoogleAdsConfig {
825
+ /**
826
+ * (Required) Manager Account ID (also called MCC Account ID) used to list and access
827
+ * customer accounts under this manager account. This is required for fetching the list
828
+ * of customer accounts during source selection.
829
+ * If the same field is also set in the object-level GoogleAdsOptions (connector_options),
830
+ * the object-level value takes precedence over this top-level config.
831
+ */
832
+ managerAccountId?: string | undefined;
833
+ }
834
+ /**
835
+ * Google Ads specific options for ingestion (object-level).
836
+ * When set, these values override the corresponding fields in GoogleAdsConfig
837
+ * (source_configurations).
838
+ */
839
+ export interface GoogleAdsOptions {
840
+ /**
841
+ * (Optional at this level) Manager Account ID (also called MCC Account ID) used to list
842
+ * and access customer accounts under this manager account.
843
+ * Overrides GoogleAdsConfig.manager_account_id from source_configurations when set.
844
+ */
845
+ managerAccountId?: string | undefined;
846
+ /**
847
+ * (Optional) Number of days to look back for report tables to capture late-arriving data.
848
+ * If not specified, defaults to 30 days.
849
+ */
850
+ lookbackWindowDays?: number | undefined;
851
+ /**
852
+ * (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.
853
+ * This determines the earliest date from which to sync historical data.
854
+ * If not specified, defaults to 2 years of historical data.
855
+ */
856
+ syncStartDate?: string | undefined;
857
+ }
858
+ export interface GoogleDriveOptions {
859
+ /** Google Drive URL. */
860
+ url?: string | undefined;
861
+ entityType?: GoogleDriveOptions_GoogleDriveEntityType | undefined;
862
+ fileIngestionOptions?: FileIngestionOptions | undefined;
863
+ }
864
+ export interface IngestionGatewayPipelineDefinition {
865
+ /** Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. */
866
+ connectionName?: string | undefined;
867
+ /** [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. */
868
+ connectionId?: string | undefined;
869
+ /** Required, Immutable. The name of the catalog for the gateway pipeline's storage location. */
870
+ gatewayStorageCatalog?: string | undefined;
871
+ /** Required, Immutable. The name of the schema for the gateway pipelines's storage location. */
872
+ gatewayStorageSchema?: string | undefined;
873
+ /**
874
+ * Optional. The Unity Catalog-compatible name for the gateway storage location.
875
+ * This is the destination to use for the data that is extracted by the gateway.
876
+ * Spark Declarative Pipelines system will automatically create the storage location under the catalog and schema.
877
+ */
878
+ gatewayStorageName?: string | undefined;
879
+ /** Optional, Internal. Parameters required to establish an initial connection with the source. */
880
+ connectionParameters?: ConnectionParameters | undefined;
881
+ }
882
+ export interface IngestionPipelineDefinition {
883
+ /**
884
+ * (Required, Mutable) Identifies the data source for the Lakeflow Connect Ingestion pipeline.
885
+ * Exactly one option must be specified.
886
+ */
887
+ source?: {
888
+ $case: 'connectionName';
889
+ /**
890
+ * The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with
891
+ * both connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle,
892
+ * (connector_type = QUERY_BASED OR connector_type = CDC).
893
+ * If connection name corresponds to database connectors like Oracle, and connector_type is not provided then
894
+ * connector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion
895
+ * pipeline.
896
+ * Under certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed
897
+ * Ingestion Pipeline with Gateway pipeline.
898
+ */
899
+ connectionName: string;
900
+ } | {
901
+ $case: 'ingestionGatewayId';
902
+ /**
903
+ * Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database.
904
+ * This is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC).
905
+ * Under certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc
906
+ * Managed Ingestion Pipeline.
907
+ */
908
+ ingestionGatewayId: string;
909
+ } | {
910
+ $case: 'ingestFromUcForeignCatalog';
911
+ /**
912
+ * Immutable. If set to true, the pipeline will ingest tables from the
913
+ * UC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.
914
+ * The `source_catalog` fields in objects of IngestionConfig are interpreted as
915
+ * the UC foreign catalogs to ingest from.
916
+ */
917
+ ingestFromUcForeignCatalog: boolean;
918
+ } | undefined;
919
+ /** Required. Settings specifying tables to replicate and the destination for the replicated tables. */
920
+ objects?: IngestionPipelineDefinition_IngestionConfig[] | undefined;
921
+ /**
922
+ * The type of the foreign source.
923
+ * The source type will be inferred from the source connection or ingestion gateway.
924
+ * This field is output only and will be ignored if provided.
925
+ */
926
+ sourceType?: IngestionSourceType | undefined;
927
+ /** Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. */
928
+ tableConfiguration?: IngestionPipelineDefinition_TableSpecificConfig | undefined;
929
+ /**
930
+ * Netsuite only configuration. When the field is set for a netsuite connector,
931
+ * the jar stored in the field will be validated and added to the classpath of
932
+ * pipeline's cluster.
933
+ */
934
+ netsuiteJarPath?: string | undefined;
935
+ /** Top-level source configurations */
936
+ sourceConfigurations?: SourceConfig[] | undefined;
937
+ /** (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. */
938
+ fullRefreshWindow?: OperationTimeWindow | undefined;
939
+ /** (Optional) Connector Type for sources. Ex: CDC, Query Based. */
940
+ connectorType?: ConnectorType | undefined;
941
+ /**
942
+ * (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline
943
+ * with Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.
944
+ * If not specified, the volume for staged data will be created in catalog and schema/target specified in the
945
+ * top level pipeline definition.
946
+ */
947
+ dataStagingOptions?: DataStagingOptions | undefined;
948
+ }
949
+ export interface IngestionPipelineDefinition_IngestionConfig {
950
+ sourceTables?: {
951
+ $case: 'schema';
952
+ /** Select all tables from a specific source schema. */
953
+ schema: IngestionPipelineDefinition_SchemaSpec;
954
+ } | {
955
+ $case: 'table';
956
+ /** Select a specific source table. */
957
+ table: IngestionPipelineDefinition_TableSpec;
958
+ } | {
959
+ $case: 'report';
960
+ /** Select a specific source report. */
961
+ report: IngestionPipelineDefinition_ReportSpec;
962
+ } | undefined;
963
+ }
964
+ export interface IngestionPipelineDefinition_ReportSpec {
965
+ /** Required. Report URL in the source system. */
966
+ sourceUrl?: string | undefined;
967
+ /** Required. Destination catalog to store table. */
968
+ destinationCatalog?: string | undefined;
969
+ /** Required. Destination schema to store table. */
970
+ destinationSchema?: string | undefined;
971
+ /** Required. Destination table name. The pipeline fails if a table with that name already exists. */
972
+ destinationTable?: string | undefined;
973
+ /** Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. */
974
+ tableConfiguration?: IngestionPipelineDefinition_TableSpecificConfig | undefined;
975
+ }
976
+ export interface IngestionPipelineDefinition_SchemaSpec {
977
+ /** The source catalog name. Might be optional depending on the type of source. */
978
+ sourceCatalog?: string | undefined;
979
+ /** Required. Schema name in the source database. */
980
+ sourceSchema?: string | undefined;
981
+ /** Required. Destination catalog to store tables. */
982
+ destinationCatalog?: string | undefined;
983
+ /** Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. */
984
+ destinationSchema?: string | undefined;
985
+ /** Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. */
986
+ tableConfiguration?: IngestionPipelineDefinition_TableSpecificConfig | undefined;
987
+ /** (Optional) Source Specific Connector Options */
988
+ connectorOptions?: ConnectorOptions | undefined;
989
+ }
990
+ export interface IngestionPipelineDefinition_TableSpec {
991
+ /** Source catalog name. Might be optional depending on the type of source. */
992
+ sourceCatalog?: string | undefined;
993
+ /** Schema name in the source database. Might be optional depending on the type of source. */
994
+ sourceSchema?: string | undefined;
995
+ /** Required. Table name in the source database. */
996
+ sourceTable?: string | undefined;
997
+ /** Required. Destination catalog to store table. */
998
+ destinationCatalog?: string | undefined;
999
+ /** Required. Destination schema to store table. */
1000
+ destinationSchema?: string | undefined;
1001
+ /** Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. */
1002
+ destinationTable?: string | undefined;
1003
+ /** Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. */
1004
+ tableConfiguration?: IngestionPipelineDefinition_TableSpecificConfig | undefined;
1005
+ /** (Optional) Source Specific Connector Options */
1006
+ connectorOptions?: ConnectorOptions | undefined;
1007
+ }
1008
+ export interface IngestionPipelineDefinition_TableSpecificConfig {
1009
+ scdType?: ScdType_ScdType | undefined;
1010
+ /** The primary key of the table used to apply changes. */
1011
+ primaryKeys?: string[] | undefined;
1012
+ /** The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. */
1013
+ sequenceBy?: string[] | undefined;
1014
+ /**
1015
+ * A list of column names to be included for the ingestion.
1016
+ * When not specified, all columns except ones in exclude_columns will be included. Future
1017
+ * columns will be automatically included.
1018
+ * When specified, all other future columns will be automatically excluded from ingestion.
1019
+ * This field in mutually exclusive with `exclude_columns`.
1020
+ */
1021
+ includeColumns?: string[] | undefined;
1022
+ /**
1023
+ * A list of column names to be excluded for the ingestion.
1024
+ * When not specified, include_columns fully controls what columns to be ingested.
1025
+ * When specified, all other columns including future ones will be automatically included for ingestion.
1026
+ * This field in mutually exclusive with `include_columns`.
1027
+ */
1028
+ excludeColumns?: string[] | undefined;
1029
+ /** If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector */
1030
+ salesforceIncludeFormulaFields?: boolean | undefined;
1031
+ /** (Optional) Additional custom parameters for Workday Report */
1032
+ workdayReportParameters?: IngestionPipelineDefinition_WorkdayReportParameters | undefined;
1033
+ /**
1034
+ * (Optional, Immutable) The row filter condition to be applied to the table.
1035
+ * It must not contain the WHERE keyword, only the actual filter condition.
1036
+ * It must be in DBSQL format.
1037
+ */
1038
+ rowFilter?: string | undefined;
1039
+ queryBasedConnectorConfig?: IngestionPipelineDefinition_TableSpecificConfig_QueryBasedConnectorConfig | undefined;
1040
+ /**
1041
+ * (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try
1042
+ * to fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy
1043
+ * in table configuration will override the above level auto_full_refresh_policy.
1044
+ * For example,
1045
+ * {
1046
+ * "auto_full_refresh_policy": {
1047
+ * "enabled": true,
1048
+ * "min_interval_hours": 23,
1049
+ * }
1050
+ * }
1051
+ * If unspecified, auto full refresh is disabled.
1052
+ */
1053
+ autoFullRefreshPolicy?: AutoFullRefreshPolicy | undefined;
1054
+ }
1055
+ /** Configurations that are only applicable for query-based ingestion connectors. */
1056
+ export interface IngestionPipelineDefinition_TableSpecificConfig_QueryBasedConnectorConfig {
1057
+ /**
1058
+ * The names of the monotonically increasing columns in the source table that are used to enable
1059
+ * the table to be read and ingested incrementally through structured streaming.
1060
+ * The columns are allowed to have repeated values but have to be non-decreasing.
1061
+ * If the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these
1062
+ * columns will implicitly define the `sequence_by` behavior. You can still explicitly set
1063
+ * `sequence_by` to override this default.
1064
+ */
1065
+ cursorColumns?: string[] | undefined;
1066
+ /**
1067
+ * Specifies a SQL WHERE condition that specifies that the source row has been deleted.
1068
+ * This is sometimes referred to as "soft-deletes".
1069
+ * For example: "Operation = 'DELETE'" or "is_deleted = true".
1070
+ * This field is orthogonal to `hard_deletion_sync_interval_in_seconds`,
1071
+ * one for soft-deletes and the other for hard-deletes.
1072
+ * See also the hard_deletion_sync_min_interval_in_seconds field for
1073
+ * handling of "hard deletes" where the source rows are physically removed from the table.
1074
+ */
1075
+ deletionCondition?: string | undefined;
1076
+ /**
1077
+ * Specifies the minimum interval (in seconds) between snapshots on primary keys
1078
+ * for detecting and synchronizing hard deletions—i.e., rows that have been
1079
+ * physically removed from the source table.
1080
+ * This interval acts as a lower bound. If ingestion runs less frequently than
1081
+ * this value, hard deletion synchronization will align with the actual ingestion
1082
+ * frequency instead of happening more often.
1083
+ * If not set, hard deletion synchronization via snapshots is disabled.
1084
+ * This field is mutable and can be updated without triggering a full snapshot.
1085
+ */
1086
+ hardDeletionSyncMinIntervalInSeconds?: bigint | undefined;
1087
+ }
1088
+ export interface IngestionPipelineDefinition_WorkdayReportParameters {
1089
+ /**
1090
+ * (Optional) Marks the report as incremental.
1091
+ * This field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now
1092
+ * controlled by the `parameters` field.
1093
+ */
1094
+ incremental?: boolean | undefined;
1095
+ /**
1096
+ * (Optional) Additional custom parameters for Workday Report
1097
+ * This field is deprecated and should not be used. Use `parameters` instead.
1098
+ */
1099
+ reportParameters?: IngestionPipelineDefinition_WorkdayReportParameters_QueryKeyValue[] | undefined;
1100
+ /**
1101
+ * Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"),
1102
+ * and the corresponding value is a SQL-like expression used to compute the parameter value at runtime.
1103
+ * Example:
1104
+ * {
1105
+ * "start_date": "{ coalesce(current_offset(), date(\"2025-02-01\")) }",
1106
+ * "end_date": "{ current_date() - INTERVAL 1 DAY }"
1107
+ * }
1108
+ */
1109
+ parameters?: Record<string, string> | undefined;
1110
+ }
1111
+ /** Key value pair used to specify configuration parameters to Execution */
1112
+ export interface IngestionPipelineDefinition_WorkdayReportParameters_ParametersEntry {
1113
+ key?: string | undefined;
1114
+ value?: string | undefined;
1115
+ }
1116
+ export interface IngestionPipelineDefinition_WorkdayReportParameters_QueryKeyValue {
1117
+ /** Key for the report parameter, can be a column name or other metadata */
1118
+ key?: string | undefined;
1119
+ /**
1120
+ * Value for the report parameter.
1121
+ * Possible values it can take are these sql functions:
1122
+ * 1. coalesce(current_offset(), date("YYYY-MM-DD")) -> if current_offset() is null, then the passed date, else current_offset()
1123
+ * 2. current_date()
1124
+ * 3. date_sub(current_date(), x) -> subtract x (some non-negative integer) days from current date
1125
+ */
1126
+ value?: string | undefined;
1127
+ }
1128
+ /** Jira specific options for ingestion */
1129
+ export interface JiraConnectorOptions {
1130
+ /** (Optional) Projects to filter Jira data on */
1131
+ includeJiraSpaces?: string[] | undefined;
1132
+ }
1133
+ export interface JsonTransformerOptions {
1134
+ /** Parse the entire value as a single Variant column. */
1135
+ asVariant?: boolean | undefined;
1136
+ /** Inline schema string for JSON parsing (Spark DDL format). */
1137
+ schema?: string | undefined;
1138
+ /** Path to a schema file (.ddl). */
1139
+ schemaFilePath?: string | undefined;
1140
+ /** (Optional) Schema evolution mode for schema inference. */
1141
+ schemaEvolutionMode?: FileIngestionOptions_SchemaEvolutionMode | undefined;
1142
+ /** (Optional) Schema hints as a comma-separated string of "column_name type" pairs. */
1143
+ schemaHints?: string | undefined;
1144
+ }
1145
+ export interface KafkaOptions {
1146
+ /**
1147
+ * Topics to subscribe to.
1148
+ * Only one of topics or topic_pattern must be specified.
1149
+ */
1150
+ topics?: string[] | undefined;
1151
+ /**
1152
+ * Java regex pattern to subscribe to matching topics.
1153
+ * Only one of topics or topic_pattern must be specified.
1154
+ */
1155
+ topicPattern?: string | undefined;
1156
+ /**
1157
+ * (Optional) Transformer for the message key.
1158
+ * If not specified, the key is left as raw bytes.
1159
+ */
1160
+ keyTransformer?: Transformer | undefined;
1161
+ /**
1162
+ * (Optional) Transformer for the message value.
1163
+ * If not specified, the value is left as raw bytes.
1164
+ */
1165
+ valueTransformer?: Transformer | undefined;
1166
+ /**
1167
+ * (Optional) Where to begin reading when no checkpoint exists.
1168
+ * Valid values: "latest" and "earliest". Defaults to "latest".
1169
+ */
1170
+ startingOffset?: string | undefined;
1171
+ /** Internal option to control the maximum number of offsets to process per trigger. */
1172
+ maxOffsetsPerTrigger?: bigint | undefined;
1173
+ /**
1174
+ * Undocumented backdoor mechanism for overriding parameters
1175
+ * to pass to the Kafka client.
1176
+ * This is not supported and may break at any time.
1177
+ */
1178
+ clientConfig?: Record<string, string> | undefined;
1179
+ }
1180
+ export interface KafkaOptions_ClientConfigEntry {
1181
+ key?: string | undefined;
1182
+ value?: string | undefined;
1183
+ }
1184
+ /**
1185
+ * The request/response messages for the ListPipelines API. The default behavior is to return
1186
+ * the 25 newest events in timestamp descending order for the given pipeline.
1187
+ */
1188
+ export interface ListPipelineEventsRequest {
1189
+ /** The pipeline to return events for. */
1190
+ pipelineId?: string | undefined;
1191
+ /**
1192
+ * Page token returned by previous call. This field is mutually
1193
+ * exclusive with all fields in this request except max_results. An error is
1194
+ * returned if any fields other than max_results are set when this field is set.
1195
+ */
1196
+ pageToken?: string | undefined;
1197
+ /**
1198
+ * Max number of entries to return in a single page. The system may return
1199
+ * fewer than max_results events in a response, even if there are more events
1200
+ * available.
1201
+ */
1202
+ maxResults?: number | undefined;
1203
+ /**
1204
+ * A string indicating a sort order by timestamp for the results, for example, ["timestamp asc"].
1205
+ * The sort order can be ascending or descending. By default, events are returned
1206
+ * in descending order by timestamp.
1207
+ */
1208
+ orderBy?: string[] | undefined;
1209
+ /**
1210
+ * Criteria to select a subset of results, expressed using a SQL-like syntax.
1211
+ * The supported filters are:
1212
+ * 1. level='INFO' (or WARN or ERROR)
1213
+ * 2. level in ('INFO', 'WARN')
1214
+ * 3. id='[event-id]'
1215
+ * 4. timestamp > 'TIMESTAMP' (or >=,<,<=,=)
1216
+ *
1217
+ * Composite expressions are supported, for example: level in ('ERROR', 'WARN')
1218
+ * AND timestamp> '2021-07-22T06:37:33.083Z'
1219
+ */
1220
+ filter?: string | undefined;
1221
+ }
1222
+ export interface ListPipelineEventsRequest_Response {
1223
+ /** The list of events matching the request criteria. */
1224
+ events?: PipelineEvent[] | undefined;
1225
+ /** If present, a token to fetch the next page of events. */
1226
+ nextPageToken?: string | undefined;
1227
+ /** If present, a token to fetch the previous page of events. */
1228
+ prevPageToken?: string | undefined;
1229
+ }
1230
+ /**
1231
+ * The request/response messages for the ListPipelines API. The default behavior is to return
1232
+ * the 25 first pipelines in ascending order of pipeline id.
1233
+ */
1234
+ export interface ListPipelinesRequest {
1235
+ /** Page token returned by previous call */
1236
+ pageToken?: string | undefined;
1237
+ /**
1238
+ * The maximum number of entries to return in a single page. The system may
1239
+ * return fewer than max_results events in a response, even if there are
1240
+ * more events available. This field is optional. The default value is 25.
1241
+ * The maximum value is 100. An error is returned if the value of max_results
1242
+ * is greater than 100.
1243
+ */
1244
+ maxResults?: number | undefined;
1245
+ /**
1246
+ * A list of strings specifying the order of results.
1247
+ * Supported order_by fields are id and name. The default is id asc.
1248
+ * This field is optional.
1249
+ */
1250
+ orderBy?: string[] | undefined;
1251
+ /**
1252
+ * Select a subset of results based on the specified criteria.
1253
+ * The supported filters are:
1254
+ *
1255
+ * * `notebook='<path>'` to select pipelines that reference the provided notebook path.
1256
+ * * `name LIKE '[pattern]'` to select pipelines with a name that matches pattern.
1257
+ * Wildcards are supported, for example: `name LIKE '%shopping%'`
1258
+ *
1259
+ * Composite filters are not supported. This field is optional.
1260
+ */
1261
+ filter?: string | undefined;
1262
+ }
1263
+ export interface ListPipelinesRequest_Response {
1264
+ /** The list of events matching the request criteria. */
1265
+ statuses?: PipelineStateInfo[] | undefined;
1266
+ /** If present, a token to fetch the next page of events. */
1267
+ nextPageToken?: string | undefined;
1268
+ }
1269
+ /**
1270
+ * The request/response messages for the ListUpdates API. The default behavior is to return
1271
+ * the 25 most recent updates in timestamp descending order for the given pipeline. No custom
1272
+ * sorting or filtering is supported.
1273
+ */
1274
+ export interface ListUpdatesRequest {
1275
+ /** The pipeline to return updates for. */
1276
+ pipelineId?: string | undefined;
1277
+ /** Page token returned by previous call */
1278
+ pageToken?: string | undefined;
1279
+ /** Max number of entries to return in a single page. */
1280
+ maxResults?: number | undefined;
1281
+ /** If present, returns updates until and including this update_id. */
1282
+ untilUpdateId?: string | undefined;
1283
+ }
1284
+ export interface ListUpdatesRequest_Response {
1285
+ updates?: UpdateInfo[] | undefined;
1286
+ /**
1287
+ * If present, then there are more results, and this a token to be used in a subsequent request
1288
+ * to fetch the next page.
1289
+ */
1290
+ nextPageToken?: string | undefined;
1291
+ /** If present, then this token can be used in a subsequent request to fetch the previous page. */
1292
+ prevPageToken?: string | undefined;
1293
+ }
1294
+ export interface ManualTrigger {
1295
+ }
1296
+ /** Meta Marketing (Meta Ads) specific options for ingestion */
1297
+ export interface MetaMarketingOptions {
1298
+ /** (Optional) Granularity of data to pull (account, ad, adset, campaign) */
1299
+ level?: string | undefined;
1300
+ /** (Optional) Breakdowns to configure for data aggregation */
1301
+ breakdowns?: string[] | undefined;
1302
+ /** (Optional) Action breakdowns to configure for data aggregation */
1303
+ actionBreakdowns?: string[] | undefined;
1304
+ /** (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) */
1305
+ actionReportTime?: string | undefined;
1306
+ /**
1307
+ * (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added
1308
+ * after this date will be ingested
1309
+ */
1310
+ startDate?: string | undefined;
1311
+ /**
1312
+ * (Optional) Window in days to revisit data during sync to capture
1313
+ * updated conversion data from the API.
1314
+ */
1315
+ customInsightsLookbackWindow?: number | undefined;
1316
+ /** (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) */
1317
+ timeIncrement?: string | undefined;
1318
+ /** (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") */
1319
+ actionAttributionWindows?: string[] | undefined;
1320
+ }
1321
+ export interface NotebookLibrary {
1322
+ /** The absolute path of the source code. */
1323
+ path?: string | undefined;
1324
+ }
1325
+ export interface Notifications {
1326
+ /** A list of email addresses notified when a configured alert is triggered. */
1327
+ emailRecipients?: string[] | undefined;
1328
+ /**
1329
+ * A list of alerts that trigger the sending of notifications to the configured
1330
+ * destinations. The supported alerts are:
1331
+ *
1332
+ * * `on-update-success`: A pipeline update completes successfully.
1333
+ * * `on-update-failure`: Each time a pipeline update fails.
1334
+ * * `on-update-fatal-failure`: A pipeline update fails with a non-retryable (fatal) error.
1335
+ * * `on-flow-failure`: A single data flow fails.
1336
+ */
1337
+ alerts?: string[] | undefined;
1338
+ }
1339
+ /** Proto representing a window */
1340
+ export interface OperationTimeWindow {
1341
+ /** An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. */
1342
+ startHour?: number | undefined;
1343
+ /**
1344
+ * Days of week in which the window is allowed to happen
1345
+ * If not specified all days of the week will be used.
1346
+ */
1347
+ daysOfWeek?: DayOfWeek[] | undefined;
1348
+ /**
1349
+ * Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.
1350
+ * If not specified, UTC will be used.
1351
+ */
1352
+ timeZoneId?: string | undefined;
1353
+ }
1354
+ export interface Origin {
1355
+ /** The cloud provider, e.g., AWS or Azure. */
1356
+ cloud?: string | undefined;
1357
+ /** The cloud region. */
1358
+ region?: string | undefined;
1359
+ /** The org id of the user. Unique within a cloud. */
1360
+ orgId?: bigint | undefined;
1361
+ /** The id of the pipeline. Globally unique. */
1362
+ pipelineId?: string | undefined;
1363
+ /** The name of the pipeline. Not unique. */
1364
+ pipelineName?: string | undefined;
1365
+ /** The id of the cluster where an execution happens. Unique within a region. */
1366
+ clusterId?: string | undefined;
1367
+ /** The id of an execution. Globally unique. */
1368
+ updateId?: string | undefined;
1369
+ /** The id of a maintenance run. Globally unique. */
1370
+ maintenanceId?: string | undefined;
1371
+ /** The id of a (delta) table. Globally unique. */
1372
+ tableId?: string | undefined;
1373
+ /** The name of a dataset. Unique within a pipeline. */
1374
+ datasetName?: string | undefined;
1375
+ /**
1376
+ * The id of the flow. Globally unique. Incremental queries will generally
1377
+ * reuse the same id while complete queries will have a new id per update.
1378
+ */
1379
+ flowId?: string | undefined;
1380
+ /** The name of the flow. Not unique. */
1381
+ flowName?: string | undefined;
1382
+ /** The id of a batch. Unique within a flow. */
1383
+ batchId?: bigint | undefined;
1384
+ /** The id of the request that caused an update. */
1385
+ requestId?: string | undefined;
1386
+ /** The Unity Catalog id of the MV or ST being updated. */
1387
+ ucResourceId?: string | undefined;
1388
+ /** The optional host name where the event was triggered */
1389
+ host?: string | undefined;
1390
+ /** Materialization name. */
1391
+ materializationName?: string | undefined;
1392
+ /** The name of the source UC connection (if known) from whose data ingestion is described by this event. */
1393
+ ingestionSourceConnectionName?: string | undefined;
1394
+ /** The name of the source catalog name (if known) from whose data ingestion is described by this event. */
1395
+ ingestionSourceCatalogName?: string | undefined;
1396
+ /** The name of the source schema name (if known) from whose data ingestion is described by this event. */
1397
+ ingestionSourceSchemaName?: string | undefined;
1398
+ /** The name of the source table name (if known) from whose data ingestion is described by this event. */
1399
+ ingestionSourceTableName?: string | undefined;
1400
+ /** An optional implementation-defined source table version of a dataset being (re)ingested. */
1401
+ ingestionSourceTableVersion?: string | undefined;
1402
+ }
1403
+ /** Outlook specific options for ingestion */
1404
+ export interface OutlookOptions {
1405
+ /** Deprecated. Use include_folders instead. */
1406
+ folderFilter?: string[] | undefined;
1407
+ /** Deprecated. Use include_senders instead. */
1408
+ senderFilter?: string[] | undefined;
1409
+ /** Deprecated. Use include_subjects instead. */
1410
+ subjectFilter?: string[] | undefined;
1411
+ /**
1412
+ * (Optional) Start date for the initial sync in YYYY-MM-DD format.
1413
+ * Format: YYYY-MM-DD (e.g., 2024-01-01)
1414
+ * This determines the earliest date from which to sync historical data.
1415
+ * If not specified, complete history is ingested.
1416
+ */
1417
+ startDate?: string | undefined;
1418
+ /**
1419
+ * (Optional) Defines how the body_content column is populated.
1420
+ * TEXT_HTML: Preserves full formatting, links, and styling.
1421
+ * TEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.
1422
+ */
1423
+ bodyFormat?: OutlookBodyFormat | undefined;
1424
+ /**
1425
+ * (Optional) Controls which attachments to ingest.
1426
+ * If not specified, defaults to ALL.
1427
+ */
1428
+ attachmentMode?: OutlookAttachmentMode | undefined;
1429
+ /**
1430
+ * (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).
1431
+ * If not specified, all accessible mailboxes are ingested.
1432
+ * Filter semantics: OR between different mailboxes.
1433
+ */
1434
+ includeMailboxes?: string[] | undefined;
1435
+ /**
1436
+ * (Optional) Filter mail folders to include in the sync.
1437
+ * If not specified, all folders will be synced.
1438
+ * Examples: Inbox, Sent Items, Custom_Folder
1439
+ * Filter semantics: OR between different folders.
1440
+ */
1441
+ includeFolders?: string[] | undefined;
1442
+ /**
1443
+ * (Optional) Filter emails by sender address. Uses exact email match.
1444
+ * Examples: user@vendor.com, alerts@system.io, noreply@company.com
1445
+ * If not specified, emails from all senders will be synced.
1446
+ * Filter semantics: OR between different senders.
1447
+ */
1448
+ includeSenders?: string[] | undefined;
1449
+ /**
1450
+ * (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with
1451
+ * the part before "*"); otherwise substring match (subject contains the value).
1452
+ * Examples: "Invoice" (substring), "Re:*" (prefix), "Support Ticket", "URGENT*"
1453
+ * If not specified, emails with all subjects will be synced.
1454
+ * Filter semantics: OR between different subjects.
1455
+ */
1456
+ includeSubjects?: string[] | undefined;
1457
+ }
1458
+ export interface PathPattern {
1459
+ /** The source code to include for pipelines */
1460
+ include?: string | undefined;
1461
+ }
1462
+ export interface PipelineCluster {
1463
+ /** A label for the cluster specification, either `default` to configure the default cluster, or `maintenance` to configure the maintenance cluster. This field is optional. The default value is `default`. */
1464
+ label?: string | undefined;
1465
+ /** Note: This field won't be persisted. Only API users will check this field. */
1466
+ applyPolicyDefaultValues?: boolean | undefined;
1467
+ /**
1468
+ * An object containing a set of optional, user-specified Spark configuration key-value pairs.
1469
+ * See :method:clusters/create for more details.
1470
+ */
1471
+ sparkConf?: Record<string, string> | undefined;
1472
+ /**
1473
+ * Attributes related to clusters running on Amazon Web Services.
1474
+ * If not specified at cluster creation, a set of default values will be used.
1475
+ */
1476
+ awsAttributes?: PipelinesAwsAttributes | undefined;
1477
+ /**
1478
+ * Attributes related to clusters running on Microsoft Azure.
1479
+ * If not specified at cluster creation, a set of default values will be used.
1480
+ */
1481
+ azureAttributes?: PipelinesAzureAttributes | undefined;
1482
+ /**
1483
+ * Attributes related to clusters running on Google Cloud Platform.
1484
+ * If not specified at cluster creation, a set of default values will be used.
1485
+ */
1486
+ gcpAttributes?: PipelinesGcpAttributes | undefined;
1487
+ /**
1488
+ * This field encodes, through a single value, the resources available to each of
1489
+ * the Spark nodes in this cluster. For example, the Spark nodes can be provisioned
1490
+ * and optimized for memory or compute intensive workloads. A list of available node
1491
+ * types can be retrieved by using the :method:clusters/listNodeTypes API call.
1492
+ */
1493
+ nodeTypeId?: string | undefined;
1494
+ /**
1495
+ * The node type of the Spark driver.
1496
+ * Note that this field is optional; if unset, the driver node type will be set as the same value
1497
+ * as `node_type_id` defined above.
1498
+ */
1499
+ driverNodeTypeId?: string | undefined;
1500
+ /**
1501
+ * SSH public key contents that will be added to each Spark node in this cluster. The
1502
+ * corresponding private keys can be used to login with the user name `ubuntu` on port `2200`.
1503
+ * Up to 10 keys can be specified.
1504
+ */
1505
+ sshPublicKeys?: string[] | undefined;
1506
+ /**
1507
+ * Additional tags for cluster resources. <Databricks> will tag all cluster resources (e.g., AWS
1508
+ * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
1509
+ *
1510
+ * - Currently, <Databricks> allows at most 45 custom tags
1511
+ *
1512
+ * - Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags
1513
+ */
1514
+ customTags?: Record<string, string> | undefined;
1515
+ /**
1516
+ * The configuration for delivering spark logs to a long-term storage destination.
1517
+ * Only dbfs destinations are supported. Only one destination can be specified
1518
+ * for one cluster. If the conf is given, the logs will be delivered to the destination every
1519
+ * `5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while
1520
+ * the destination of executor logs is `$destination/$clusterId/executor`.
1521
+ */
1522
+ clusterLogConf?: PipelinesClusterLogConf | undefined;
1523
+ /**
1524
+ * An object containing a set of optional, user-specified environment variable key-value pairs.
1525
+ * Please note that key-value pair of the form (X,Y) will be exported as is (i.e.,
1526
+ * `export X='Y'`) while launching the driver and workers.
1527
+ *
1528
+ * In order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending
1529
+ * them to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all
1530
+ * default databricks managed environmental variables are included as well.
1531
+ *
1532
+ * Example Spark environment variables:
1533
+ * `{"SPARK_WORKER_MEMORY": "28000m", "SPARK_LOCAL_DIRS": "/local_disk0"}` or
1534
+ * `{"SPARK_DAEMON_JAVA_OPTS": "$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true"}`
1535
+ */
1536
+ sparkEnvVars?: Record<string, string> | undefined;
1537
+ /** The configuration for storing init scripts. Any number of destinations can be specified. The scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified, init script logs are sent to `<destination>/<cluster-ID>/init_scripts`. */
1538
+ initScripts?: PipelinesInitScriptInfo[] | undefined;
1539
+ /** The optional ID of the instance pool to which the cluster belongs. */
1540
+ instancePoolId?: string | undefined;
1541
+ /** The ID of the cluster policy used to create the cluster if applicable. */
1542
+ policyId?: string | undefined;
1543
+ /** Whether to enable local disk encryption for the cluster. */
1544
+ enableLocalDiskEncryption?: boolean | undefined;
1545
+ /**
1546
+ * The optional ID of the instance pool for the driver of the cluster belongs.
1547
+ * The pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not
1548
+ * assigned.
1549
+ */
1550
+ driverInstancePoolId?: string | undefined;
1551
+ size?: {
1552
+ $case: 'numWorkers';
1553
+ /**
1554
+ * Number of worker nodes that this cluster should have. A cluster has one Spark Driver
1555
+ * and `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.
1556
+ *
1557
+ * Note: When reading the properties of a cluster, this field reflects the desired number
1558
+ * of workers rather than the actual current number of workers. For instance, if a cluster
1559
+ * is resized from 5 to 10 workers, this field will immediately be updated to reflect
1560
+ * the target size of 10 workers, whereas the workers listed in `spark_info` will gradually
1561
+ * increase from 5 to 10 as the new nodes are provisioned.
1562
+ */
1563
+ numWorkers: number;
1564
+ } | {
1565
+ $case: 'autoscale';
1566
+ /**
1567
+ * Parameters needed in order to automatically scale clusters up and down based on load.
1568
+ * Note: autoscaling works best with DB runtime versions 3.0 or later.
1569
+ */
1570
+ autoscale: PipelinesAutoScale;
1571
+ } | undefined;
1572
+ }
1573
+ /** Key value pair used to specify configuration parameters to Execution */
1574
+ export interface PipelineCluster_CustomTagsEntry {
1575
+ key?: string | undefined;
1576
+ value?: string | undefined;
1577
+ }
1578
+ /** Key value pair used to specify configuration parameters to Execution */
1579
+ export interface PipelineCluster_SparkConfEntry {
1580
+ key?: string | undefined;
1581
+ value?: string | undefined;
1582
+ }
1583
+ /** Key value pair used to specify configuration parameters to Execution */
1584
+ export interface PipelineCluster_SparkEnvVarsEntry {
1585
+ key?: string | undefined;
1586
+ value?: string | undefined;
1587
+ }
1588
+ export interface PipelineDeployment {
1589
+ /** The deployment method that manages the pipeline. */
1590
+ kind?: DeploymentKind | undefined;
1591
+ /** The path to the file containing metadata about the deployment. */
1592
+ metadataFilePath?: string | undefined;
1593
+ /**
1594
+ * ID of the deployment that manages this pipeline. Only set when `kind` is
1595
+ * `BUNDLE`. Used to look up deployment metadata from the Deployment
1596
+ * Metadata service.
1597
+ */
1598
+ deploymentId?: string | undefined;
1599
+ /**
1600
+ * ID of the version of the deployment that produced this pipeline. Only
1601
+ * set when `kind` is `BUNDLE`. Identifies a specific snapshot of the
1602
+ * deployment in the Deployment Metadata service.
1603
+ */
1604
+ versionId?: string | undefined;
1605
+ }
1606
+ export interface PipelineEvent {
1607
+ /** A time-based, globally unique id. */
1608
+ id?: string | undefined;
1609
+ /** A sequencing object to identify and order events. */
1610
+ sequence?: Sequencing | undefined;
1611
+ /** Describes where the event originates from. */
1612
+ origin?: Origin | undefined;
1613
+ /** The time of the event. */
1614
+ timestamp?: string | undefined;
1615
+ /** The display message associated with the event. */
1616
+ message?: string | undefined;
1617
+ /** The severity level of the event. */
1618
+ level?: EventLevel | undefined;
1619
+ /** Information about an error captured by the event. */
1620
+ error?: ErrorDetail | undefined;
1621
+ /** The event type. Should always correspond to the details */
1622
+ eventType?: string | undefined;
1623
+ /** Maturity level for event_type. */
1624
+ maturityLevel?: MaturityLevel | undefined;
1625
+ /**
1626
+ * Information about which fields were truncated from this event due to size constraints.
1627
+ * If empty or absent, no truncation occurred.
1628
+ * See https://docs.databricks.com/en/ldp/monitor-event-logs for information on
1629
+ * retrieving complete event data.
1630
+ */
1631
+ truncation?: Truncation | undefined;
1632
+ }
1633
+ export interface PipelineLibrary {
1634
+ lib?: {
1635
+ $case: 'jar';
1636
+ /** URI of the jar to be installed. Currently only DBFS is supported. */
1637
+ jar: string;
1638
+ } | {
1639
+ $case: 'maven';
1640
+ /** Specification of a maven library to be installed. */
1641
+ maven: PipelinesMavenLibrary;
1642
+ } | {
1643
+ $case: 'whl';
1644
+ /** URI of the whl to be installed. */
1645
+ whl: string;
1646
+ } | {
1647
+ $case: 'notebook';
1648
+ /** The path to a notebook that defines a pipeline and is stored in the <Databricks> workspace. */
1649
+ notebook: NotebookLibrary;
1650
+ } | {
1651
+ $case: 'file';
1652
+ /** The path to a file that defines a pipeline and is stored in the Databricks Repos. */
1653
+ file: NotebookLibrary;
1654
+ } | {
1655
+ $case: 'glob';
1656
+ /**
1657
+ * The unified field to include source codes.
1658
+ * Each entry can be a notebook path, a file path, or a folder path that ends `/\**`.
1659
+ * This field cannot be used together with `notebook` or `file`.
1660
+ */
1661
+ glob: PathPattern;
1662
+ } | undefined;
1663
+ }
1664
+ export interface PipelineSpec {
1665
+ /** Unique identifier for this pipeline. */
1666
+ id?: string | undefined;
1667
+ /** Friendly identifier for this pipeline. */
1668
+ name?: string | undefined;
1669
+ /** DBFS root directory for storing checkpoints and tables. */
1670
+ storage?: string | undefined;
1671
+ /** String-String configuration for this pipeline execution. */
1672
+ configuration?: Record<string, string> | undefined;
1673
+ /** Cluster settings for this pipeline deployment. */
1674
+ clusters?: PipelineCluster[] | undefined;
1675
+ /** Libraries or code needed by this deployment. */
1676
+ libraries?: PipelineLibrary[] | undefined;
1677
+ /** The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. */
1678
+ ingestionDefinition?: IngestionPipelineDefinition | undefined;
1679
+ /** The definition of a gateway pipeline to support change data capture. */
1680
+ gatewayDefinition?: IngestionGatewayPipelineDefinition | undefined;
1681
+ /** Which pipeline trigger to use. Deprecated: Use `continuous` instead. */
1682
+ trigger?: PipelineTrigger | undefined;
1683
+ /** Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field. */
1684
+ target?: string | undefined;
1685
+ /** The default schema (database) where tables are read from or published to. */
1686
+ schema?: string | undefined;
1687
+ /** Filters on which Pipeline packages to include in the deployed graph. */
1688
+ filters?: Filters | undefined;
1689
+ /** Whether the pipeline is continuous or triggered. This replaces `trigger`. */
1690
+ continuous?: boolean | undefined;
1691
+ /** Whether the pipeline is in Development mode. Defaults to false. */
1692
+ development?: boolean | undefined;
1693
+ /** Whether Photon is enabled for this pipeline. */
1694
+ photon?: boolean | undefined;
1695
+ /** Pipeline product edition. */
1696
+ edition?: string | undefined;
1697
+ /** SDP Release Channel that specifies which version to use. */
1698
+ channel?: string | undefined;
1699
+ /** A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog. */
1700
+ catalog?: string | undefined;
1701
+ /** List of notification settings for this pipeline. */
1702
+ notifications?: Notifications[] | undefined;
1703
+ /** Whether serverless compute is enabled for this pipeline. */
1704
+ serverless?: boolean | undefined;
1705
+ /** Deployment type of this pipeline. */
1706
+ deployment?: PipelineDeployment | undefined;
1707
+ /** Restart window of this pipeline. */
1708
+ restartWindow?: RestartWindow | undefined;
1709
+ /** Budget policy of this pipeline. */
1710
+ budgetPolicyId?: string | undefined;
1711
+ /**
1712
+ * A map of tags associated with the pipeline.
1713
+ * These are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.
1714
+ * A maximum of 25 tags can be added to the pipeline.
1715
+ */
1716
+ tags?: Record<string, string> | undefined;
1717
+ /** Event log configuration for this pipeline */
1718
+ eventLog?: EventLogSpec | undefined;
1719
+ /**
1720
+ * Root path for this pipeline.
1721
+ * This is used as the root directory when editing the pipeline in the <Databricks> user interface and it is
1722
+ * added to sys.path when executing Python sources during pipeline execution.
1723
+ */
1724
+ rootPath?: string | undefined;
1725
+ /** Environment specification for this pipeline used to install dependencies. */
1726
+ environment?: PipelinesEnvironment | undefined;
1727
+ /** Usage policy of this pipeline. */
1728
+ usagePolicyId?: string | undefined;
1729
+ }
1730
+ /** Key value pair used to specify configuration parameters to Execution */
1731
+ export interface PipelineSpec_ConfigurationEntry {
1732
+ key?: string | undefined;
1733
+ value?: string | undefined;
1734
+ }
1735
+ /** A key-value entry that defines a single pipeline tags. */
1736
+ export interface PipelineSpec_TagsEntry {
1737
+ /** Mandatory key for the tag pair. */
1738
+ key?: string | undefined;
1739
+ /**
1740
+ * Optional value to be associated with the provided key.
1741
+ * If the value is not provided, the key serves as the sole identifier of this key-value pair and the values is assumed to be an empty string.
1742
+ */
1743
+ value?: string | undefined;
1744
+ }
1745
+ export interface PipelineState {
1746
+ }
1747
+ export interface PipelineStateInfo {
1748
+ /** The unique identifier of the pipeline. */
1749
+ pipelineId?: string | undefined;
1750
+ state?: PipelineState_PipelineState | undefined;
1751
+ /** The unique identifier of the cluster running the pipeline. */
1752
+ clusterId?: string | undefined;
1753
+ /** The user-friendly name of the pipeline. */
1754
+ name?: string | undefined;
1755
+ /** Status of the latest updates for the pipeline. Ordered with the newest update first. */
1756
+ latestUpdates?: UpdateStateInfo[] | undefined;
1757
+ /** The username of the pipeline creator. */
1758
+ creatorUserName?: string | undefined;
1759
+ /** The username that the pipeline runs as. This is a read only value derived from the pipeline owner. */
1760
+ runAsUserName?: string | undefined;
1761
+ /** The health of a pipeline. */
1762
+ health?: PipelineHealthStatus | undefined;
1763
+ }
1764
+ export interface PipelineTrigger {
1765
+ trigger?: {
1766
+ $case: 'manual';
1767
+ manual: ManualTrigger;
1768
+ } | {
1769
+ $case: 'cron';
1770
+ cron: CronTrigger;
1771
+ } | undefined;
1772
+ }
1773
+ export interface PipelinesAutoScale {
1774
+ /**
1775
+ * The minimum number of workers the cluster can scale down to when underutilized.
1776
+ * It is also the initial number of workers the cluster will have after creation.
1777
+ */
1778
+ minWorkers?: number | undefined;
1779
+ /** The maximum number of workers to which the cluster can scale up when overloaded. `max_workers` must be strictly greater than `min_workers`. */
1780
+ maxWorkers?: number | undefined;
1781
+ /**
1782
+ * Databricks Enhanced Autoscaling optimizes cluster utilization by automatically
1783
+ * allocating cluster resources based on workload volume, with minimal impact to
1784
+ * the data processing latency of your pipelines. Enhanced Autoscaling is available
1785
+ * for `updates` clusters only. The legacy autoscaling feature is used for `maintenance`
1786
+ * clusters.
1787
+ */
1788
+ mode?: string | undefined;
1789
+ }
1790
+ /** Attributes set during cluster creation which are related to Amazon Web Services. */
1791
+ export interface PipelinesAwsAttributes {
1792
+ /**
1793
+ * The first ``first_on_demand`` nodes of the cluster will be placed on on-demand instances.
1794
+ * If this value is greater than 0, the cluster driver node in particular will be placed on an
1795
+ * on-demand instance. If this value is greater than or equal to the current cluster size, all
1796
+ * nodes will be placed on on-demand instances. If this value is less than the current cluster
1797
+ * size, ``first_on_demand`` nodes will be placed on on-demand instances and the remainder will
1798
+ * be placed on ``availability`` instances. Note that this value does not affect
1799
+ * cluster size and cannot currently be mutated over the lifetime of a cluster.
1800
+ */
1801
+ firstOnDemand?: number | undefined;
1802
+ /**
1803
+ * Availability type used for all subsequent nodes past the ``first_on_demand`` ones.
1804
+ * Note: If ``first_on_demand`` is zero, this availability type will be used for the entire cluster.
1805
+ */
1806
+ availability?: PipelinesAwsAvailability | undefined;
1807
+ /**
1808
+ * Identifier for the availability zone/datacenter in which the cluster resides.
1809
+ * This string will be of a form like "us-west-2a". The provided availability
1810
+ * zone must be in the same region as the <Databricks> deployment. For example, "us-west-2a"
1811
+ * is not a valid zone id if the <Databricks> deployment resides in the "us-east-1" region.
1812
+ * This is an optional field at cluster creation, and if not specified, a default zone will be used.
1813
+ * If the zone specified is "auto", will try to place cluster in a zone with high availability,
1814
+ * and will retry placement in a different AZ if there is not enough capacity.
1815
+ * See [[AutoAZHelper.scala]] for more details.
1816
+ * The list of available zones as well as the default value can be found by using the
1817
+ * `List Zones`_ method.
1818
+ */
1819
+ zoneId?: string | undefined;
1820
+ /**
1821
+ * Nodes for this cluster will only be placed on AWS instances with this instance profile. If
1822
+ * omitted, nodes will be placed on instances without an IAM instance profile. The instance
1823
+ * profile must have previously been added to the <Databricks> environment by an account
1824
+ * administrator.
1825
+ *
1826
+ * This feature may only be available to certain customer plans.
1827
+ *
1828
+ * ***internal
1829
+ * If this field is ommitted, we will pull in the default from the conf if it exists.
1830
+ */
1831
+ instanceProfileArn?: string | undefined;
1832
+ /**
1833
+ * The bid price for AWS spot instances, as a percentage of the corresponding instance type's
1834
+ * on-demand price.
1835
+ * For example, if this field is set to 50, and the cluster needs a new ``r3.xlarge`` spot
1836
+ * instance, then the bid price is half of the price of
1837
+ * on-demand ``r3.xlarge`` instances. Similarly, if this field is set to 200, the bid price is twice
1838
+ * the price of on-demand ``r3.xlarge`` instances. If not specified, the default value is 100.
1839
+ * When spot instances are requested for this cluster, only spot instances whose bid price
1840
+ * percentage matches this field will be considered.
1841
+ * Note that, for safety, we enforce this field to be no more than 10000.
1842
+ *
1843
+ * ***internal
1844
+ * The default value and documentation here should be kept consistent with
1845
+ * CommonConf.defaultSpotBidPricePercent and CommonConf.maxSpotBidPricePercent.
1846
+ */
1847
+ spotBidPricePercent?: number | undefined;
1848
+ /** The type of EBS volumes that will be launched with this cluster. */
1849
+ ebsVolumeType?: PipelinesEbsVolumeType | undefined;
1850
+ /**
1851
+ * The number of volumes launched for each instance. Users can choose up to 10 volumes.
1852
+ * This feature is only enabled for supported node types. Legacy node types cannot specify
1853
+ * custom EBS volumes.
1854
+ * For node types with no instance store, at least one EBS volume needs to be specified;
1855
+ * otherwise, cluster creation will fail.
1856
+ *
1857
+ * These EBS volumes will be mounted at ``/ebs0``, ``/ebs1``, and etc.
1858
+ * Instance store volumes will be mounted at ``/local_disk0``, ``/local_disk1``, and etc.
1859
+ *
1860
+ * If EBS volumes are attached, <Databricks> will configure Spark to use only the EBS volumes for
1861
+ * scratch storage because heterogeneously sized scratch devices can lead to inefficient disk
1862
+ * utilization. If no EBS volumes are attached, <Databricks> will configure Spark to use instance
1863
+ * store volumes.
1864
+ *
1865
+ * Please note that if EBS volumes are specified, then the Spark configuration ``spark.local.dir``
1866
+ * will be overridden.
1867
+ */
1868
+ ebsVolumeCount?: number | undefined;
1869
+ /**
1870
+ * The size of each EBS volume (in GiB) launched for each instance. For general purpose
1871
+ * SSD, this value must be within the range 100 - 4096. For throughput optimized HDD,
1872
+ * this value must be within the range 500 - 4096.
1873
+ */
1874
+ ebsVolumeSize?: number | undefined;
1875
+ ebsVolumeIops?: number | undefined;
1876
+ ebsVolumeThroughput?: number | undefined;
1877
+ }
1878
+ /** Attributes set during cluster creation which are related to Azure. */
1879
+ export interface PipelinesAzureAttributes {
1880
+ /**
1881
+ * The first ``first_on_demand`` nodes of the cluster will be placed on on-demand instances.
1882
+ * This value should be greater than 0, to make sure the cluster driver node is placed on an
1883
+ * on-demand instance. If this value is greater than or equal to the current cluster size, all
1884
+ * nodes will be placed on on-demand instances. If this value is less than the current cluster
1885
+ * size, ``first_on_demand`` nodes will be placed on on-demand instances and the remainder will
1886
+ * be placed on ``availability`` instances. Note that this value does not affect
1887
+ * cluster size and cannot currently be mutated over the lifetime of a cluster.
1888
+ */
1889
+ firstOnDemand?: number | undefined;
1890
+ /**
1891
+ * Availability type used for all subsequent nodes past the ``first_on_demand`` ones.
1892
+ * Note: If ``first_on_demand`` is zero (which only happens on pool clusters), this availability
1893
+ * type will be used for the entire cluster.
1894
+ */
1895
+ availability?: PipelinesAzureAvailability | undefined;
1896
+ /**
1897
+ * The max bid price to be used for Azure spot instances.
1898
+ * The Max price for the bid cannot be higher than the on-demand price of the instance.
1899
+ * If not specified, the default value is -1, which specifies that the instance cannot be evicted
1900
+ * on the basis of price, and only on the basis of availability. Further, the value should > 0 or -1.
1901
+ */
1902
+ spotBidMaxPrice?: number | undefined;
1903
+ }
1904
+ /** Cluster log delivery config */
1905
+ export interface PipelinesClusterLogConf {
1906
+ storageInfo?: {
1907
+ $case: 'dbfs';
1908
+ /**
1909
+ * destination needs to be provided. e.g.
1910
+ * ``{ "dbfs" : { "destination" : "dbfs:/home/cluster_log" } }``
1911
+ */
1912
+ dbfs: PipelinesDbfsStorageInfo;
1913
+ } | undefined;
1914
+ }
1915
+ /** A storage location in DBFS */
1916
+ export interface PipelinesDbfsStorageInfo {
1917
+ /** dbfs destination, e.g. ``dbfs:/my/path`` */
1918
+ destination?: string | undefined;
1919
+ }
1920
+ /**
1921
+ * 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.
1922
+ * In this minimal environment spec, only pip dependencies are supported.
1923
+ */
1924
+ export interface PipelinesEnvironment {
1925
+ /**
1926
+ * List of pip dependencies, as supported by the version of pip in this environment.
1927
+ * Each dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/
1928
+ * Allowed dependency could be <requirement specifier>, <archive url/path>, <local project path>(WSFS or Volumes in <Databricks>), <vcs project url>
1929
+ */
1930
+ dependencies?: string[] | undefined;
1931
+ /**
1932
+ * The environment version of the serverless Python environment used to execute
1933
+ * customer Python code. Each environment version includes a specific Python
1934
+ * version and a curated set of pre-installed libraries with defined versions,
1935
+ * providing a stable and reproducible execution environment.
1936
+ *
1937
+ * <Databricks> supports a three-year lifecycle for each environment version.
1938
+ * For available versions and their included packages, see
1939
+ * https://docs.databricks.com/aws/en/release-notes/serverless/environment-version/
1940
+ *
1941
+ * The value should be a string representing the environment version number, for example: `"4"`.
1942
+ */
1943
+ environmentVersion?: string | undefined;
1944
+ }
1945
+ /** Attributes set during cluster creation which are related to Gcp. */
1946
+ export interface PipelinesGcpAttributes {
1947
+ /**
1948
+ * If provided, the cluster will impersonate the google service account when accessing
1949
+ * gcloud services (like GCS). The google service account
1950
+ * must have previously been added to the <Databricks> environment by an account
1951
+ * administrator.
1952
+ */
1953
+ googleServiceAccount?: string | undefined;
1954
+ /** boot disk size in GB */
1955
+ bootDiskSize?: number | undefined;
1956
+ /**
1957
+ * This field determines whether the spark executors will be scheduled to run on preemptible
1958
+ * VMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.
1959
+ */
1960
+ availability?: PipelinesGcpAvailability | undefined;
1961
+ /**
1962
+ * Identifier for the availability zone in which the cluster resides.
1963
+ * This can be one of the following:
1964
+ * - "HA" => High availability, spread nodes across availability zones for a
1965
+ * <Databricks> deployment region [default].
1966
+ * - "AUTO" => <Databricks> picks an availability zone to schedule the cluster on.
1967
+ * - A GCP availability zone => Pick One of the available zones for (machine type + region) from
1968
+ * https://cloud.google.com/compute/docs/regions-zones.
1969
+ */
1970
+ zoneId?: string | undefined;
1971
+ /**
1972
+ * The number of local SSDs to attach to each worker and driver for this cluster. If left unspecified,
1973
+ * the default number of local SSDs for the node type will be used.
1974
+ *
1975
+ * NOTE: Each instance type can only support a certain number of attached local SSDs. The value
1976
+ * specified in local_ssd_count must be valid for BOTH the driver and worker instance type. See
1977
+ * GCP docs here:
1978
+ * https://cloud.google.com/compute/docs/disks#local_ssd_machine_type_restrictions
1979
+ *
1980
+ * Validation is performed at the RPC layer and the RPC will be rejected if the specified
1981
+ * local_ssd_count is invalid.
1982
+ */
1983
+ localSsdCount?: number | undefined;
1984
+ }
1985
+ /** Config for an individual init script */
1986
+ export interface PipelinesInitScriptInfo {
1987
+ storageInfo?: {
1988
+ $case: 'dbfs';
1989
+ /**
1990
+ * destination needs to be provided. e.g.
1991
+ * ``{ "dbfs" : { "destination" : "dbfs:/init-scripts/my_script.sh" } }``
1992
+ */
1993
+ dbfs: PipelinesDbfsStorageInfo;
1994
+ } | {
1995
+ $case: 's3';
1996
+ /**
1997
+ * destination and either region or endpoint should also be provided. e.g.
1998
+ * ``{ "s3": { "destination" : "s3://init-scripts/my_script.sh", "region" : "us-west-2" } }``
1999
+ * Cluster iam role is used to access s3, please make sure the cluster iam role in
2000
+ * ``instance_profile_arn`` has permission to write data to the s3 destination.
2001
+ */
2002
+ s3: PipelinesS3StorageInfo;
2003
+ } | undefined;
2004
+ }
2005
+ /**
2006
+ * Write-only setting, available only in Create/Update calls. Specifies the user or service principal that the pipeline runs as. If not specified, the pipeline runs as the user who created the pipeline.
2007
+ *
2008
+ * Only `user_name` or `service_principal_name` can be specified. If both are specified, an error is thrown.
2009
+ */
2010
+ export interface PipelinesJobRunAs {
2011
+ identity?: {
2012
+ $case: 'userName';
2013
+ /** The email of an active workspace user. Users can only set this field to their own email. */
2014
+ userName: string;
2015
+ } | {
2016
+ $case: 'servicePrincipalName';
2017
+ /** Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role. */
2018
+ servicePrincipalName: string;
2019
+ } | undefined;
2020
+ }
2021
+ export interface PipelinesMavenLibrary {
2022
+ /** Gradle-style maven coordinates. For example: "org.jsoup:jsoup:1.7.2". */
2023
+ coordinates?: string | undefined;
2024
+ /**
2025
+ * Maven repo to install the Maven package from. If omitted, both Maven Central Repository
2026
+ * and Spark Packages are searched.
2027
+ */
2028
+ repo?: string | undefined;
2029
+ /**
2030
+ * List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`.
2031
+ *
2032
+ * Maven dependency exclusions:
2033
+ * https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.
2034
+ */
2035
+ exclusions?: string[] | undefined;
2036
+ }
2037
+ /** A storage location in Amazon S3 */
2038
+ export interface PipelinesS3StorageInfo {
2039
+ /**
2040
+ * S3 destination, e.g. ``s3://my-bucket/some-prefix`` Note that logs will be delivered using
2041
+ * cluster iam role, please make sure you set cluster iam role and the role has write access to the
2042
+ * destination. Please also note that you cannot use AWS keys to deliver logs.
2043
+ */
2044
+ destination?: string | undefined;
2045
+ /**
2046
+ * S3 region, e.g. ``us-west-2``. Either region or endpoint needs to be set. If both are set,
2047
+ * endpoint will be used.
2048
+ */
2049
+ region?: string | undefined;
2050
+ /**
2051
+ * S3 endpoint, e.g. ``https://s3-us-west-2.amazonaws.com``. Either region or endpoint needs to be set.
2052
+ * If both are set, endpoint will be used.
2053
+ */
2054
+ endpoint?: string | undefined;
2055
+ /** Flag to enable server side encryption, ``false`` by default. */
2056
+ enableEncryption?: boolean | undefined;
2057
+ /**
2058
+ * The encryption type, it could be ``sse-s3`` or ``sse-kms``. It will be used only when
2059
+ * encryption is enabled and the default type is ``sse-s3``.
2060
+ */
2061
+ encryptionType?: string | undefined;
2062
+ /** Kms key which will be used if encryption is enabled and encryption type is set to ``sse-kms``. */
2063
+ kmsKey?: string | undefined;
2064
+ /**
2065
+ * Set canned access control list for the logs, e.g. ``bucket-owner-full-control``.
2066
+ * If ``canned_cal`` is set, please make sure the cluster iam role has ``s3:PutObjectAcl`` permission on
2067
+ * the destination bucket and prefix. The full list of possible canned acl can be found at
2068
+ * http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.
2069
+ * Please also note that by default only the object owner gets full controls. If you are using cross account
2070
+ * role for writing data, you may want to set ``bucket-owner-full-control`` to make bucket owner able to
2071
+ * read the logs.
2072
+ */
2073
+ cannedAcl?: string | undefined;
2074
+ }
2075
+ /** PG-specific catalog-level configuration parameters */
2076
+ export interface PostgresCatalogConfig {
2077
+ /** Optional. The Postgres slot configuration to use for logical replication */
2078
+ slotConfig?: PostgresSlotConfig | undefined;
2079
+ }
2080
+ /** PostgresSlotConfig contains the configuration for a Postgres logical replication slot */
2081
+ export interface PostgresSlotConfig {
2082
+ /** The name of the logical replication slot to use for the Postgres source */
2083
+ slotName?: string | undefined;
2084
+ /** The name of the publication to use for the Postgres source */
2085
+ publicationName?: string | undefined;
2086
+ }
2087
+ /** Specifies a replace_where predicate override for a replace where flow. */
2088
+ export interface ReplaceWhereOverride {
2089
+ /** Name of the flow to apply this override to. */
2090
+ flowName?: string | undefined;
2091
+ /**
2092
+ * SQL predicate string to use as replace_where condition.
2093
+ * Example: `date = '2024-10-10' AND city = 'xyz'`
2094
+ */
2095
+ predicateOverride?: string | undefined;
2096
+ }
2097
+ export interface RestartWindow {
2098
+ /**
2099
+ * An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.
2100
+ * Continuous pipeline restart is triggered only within a five-hour window starting at this hour.
2101
+ */
2102
+ startHour?: number | undefined;
2103
+ /**
2104
+ * Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).
2105
+ * If not specified all days of the week will be used.
2106
+ */
2107
+ daysOfWeek?: DayOfWeek[] | undefined;
2108
+ /**
2109
+ * Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.
2110
+ * If not specified, UTC will be used.
2111
+ */
2112
+ timeZoneId?: string | undefined;
2113
+ }
2114
+ /** Configuration for rewinding a specific dataset. */
2115
+ export interface RewindDatasetSpec {
2116
+ /** The identifier of the dataset (e.g., "main.foo.tbl1"). */
2117
+ identifier?: string | undefined;
2118
+ /** Whether to cascade the rewind to dependent datasets. Must be specified. */
2119
+ cascade?: boolean | undefined;
2120
+ /** Whether to reset checkpoints for this dataset. */
2121
+ resetCheckpoints?: boolean | undefined;
2122
+ }
2123
+ /** Information about a rewind being requested for this pipeline or some of the datasets in it. */
2124
+ export interface RewindSpec {
2125
+ /**
2126
+ * The base timestamp to rewind to. Exactly one of rewind_timestamp or rewind_point_id must be
2127
+ * specified.
2128
+ */
2129
+ rewindTimestamp?: string | undefined;
2130
+ /** If true, this is a dry run and we should emit the RewindSummary but not perform the rewind. */
2131
+ dryRun?: boolean | undefined;
2132
+ /**
2133
+ * List of datasets to rewind with specific configuration for each. When not specified,
2134
+ * all datasets will be rewound with cascade = true and reset_checkpoints = true.
2135
+ */
2136
+ datasets?: RewindDatasetSpec[] | undefined;
2137
+ }
2138
+ export interface ScdType {
2139
+ }
2140
+ export interface Sequencing {
2141
+ /** the ID assigned by the data plane. */
2142
+ dataPlaneId?: DataPlaneId | undefined;
2143
+ /** A sequence number, unique and increasing per pipeline. */
2144
+ controlPlaneSeqNo?: bigint | undefined;
2145
+ }
2146
+ export interface SerializedException {
2147
+ /** Runtime class of the exception */
2148
+ className?: string | undefined;
2149
+ /** Exception message */
2150
+ message?: string | undefined;
2151
+ /** Stack trace consisting of a list of stack frames */
2152
+ stack?: StackFrame[] | undefined;
2153
+ }
2154
+ export interface SharepointOptions {
2155
+ /** Required. The SharePoint URL. */
2156
+ url?: string | undefined;
2157
+ /**
2158
+ * (Optional) The type of SharePoint entity to ingest.
2159
+ * If not specified, defaults to FILE.
2160
+ */
2161
+ entityType?: SharepointOptions_SharepointEntityType | undefined;
2162
+ /** (Optional) File ingestion options for processing files. */
2163
+ fileIngestionOptions?: FileIngestionOptions | undefined;
2164
+ }
2165
+ /** Smartsheet specific options for ingestion */
2166
+ export interface SmartsheetOptions {
2167
+ /**
2168
+ * (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/
2169
+ * Checkbox/etc.). Cells that do not conform to the declared type are set to NULL.
2170
+ * When false, all columns land as STRING. Use false for sheets with irregular data or columns
2171
+ * that frequently violate their own declared type.
2172
+ * If not specified, defaults to true.
2173
+ */
2174
+ enforceSchema?: boolean | undefined;
2175
+ }
2176
+ /** SourceCatalogConfig contains catalog-level custom configuration parameters for each source */
2177
+ export interface SourceCatalogConfig {
2178
+ /** Source catalog name */
2179
+ sourceCatalog?: string | undefined;
2180
+ /** Configuration options for the source catalog */
2181
+ options?: {
2182
+ $case: 'postgres';
2183
+ /** Postgres-specific catalog-level configuration parameters */
2184
+ postgres: PostgresCatalogConfig;
2185
+ } | undefined;
2186
+ }
2187
+ export interface SourceConfig {
2188
+ /** Catalog-level source configuration parameters */
2189
+ catalog?: SourceCatalogConfig | undefined;
2190
+ /**
2191
+ * Connector-specific top-level configuration. Values here act as defaults and
2192
+ * can be overridden by the same field in the object-level connector_options.
2193
+ */
2194
+ connectorConfig?: {
2195
+ $case: 'googleAdsConfig';
2196
+ googleAdsConfig: GoogleAdsConfig;
2197
+ } | undefined;
2198
+ }
2199
+ export interface StackFrame {
2200
+ /** Class from which the method call originated */
2201
+ declaringClass?: string | undefined;
2202
+ /** Name of the method which was called */
2203
+ methodName?: string | undefined;
2204
+ /** File where the method is defined */
2205
+ fileName?: string | undefined;
2206
+ /** Line from which the method was called */
2207
+ lineNumber?: number | undefined;
2208
+ }
2209
+ export interface StartUpdateRequest {
2210
+ pipelineId?: string | undefined;
2211
+ /** If true, this update will reset all tables before running. */
2212
+ fullRefresh?: boolean | undefined;
2213
+ cause?: UpdateCause | undefined;
2214
+ /**
2215
+ * A list of tables to update without fullRefresh. If both refresh_selection and
2216
+ * full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means
2217
+ * that the states of the table will be reset before the refresh.
2218
+ */
2219
+ refreshSelection?: string[] | undefined;
2220
+ /**
2221
+ * A list of tables to update with fullRefresh. If both refresh_selection and
2222
+ * full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means
2223
+ * that the states of the table will be reset before the refresh.
2224
+ */
2225
+ fullRefreshSelection?: string[] | undefined;
2226
+ /**
2227
+ * A list of flows for which this update should reset the streaming checkpoint. This selection will not clear
2228
+ * the data in the flow's target table. Flows in this list may also appear in refresh_selection and full_refresh_selection.
2229
+ */
2230
+ resetCheckpointSelection?: string[] | undefined;
2231
+ /** If true, this update only validates the correctness of pipeline source code but does not materialize or publish any datasets. */
2232
+ validateOnly?: boolean | undefined;
2233
+ /**
2234
+ * The information about the requested rewind operation.
2235
+ * If specified this is a rewind mode update.
2236
+ */
2237
+ rewindSpec?: RewindSpec | undefined;
2238
+ /** Key/value map of parameters to pass to the pipeline execution */
2239
+ parameters?: Record<string, string> | undefined;
2240
+ /**
2241
+ * A list of predicate overrides for replace_where flows in this update.
2242
+ * Only replace_where flows may be specified. Flows not listed use their original predicate.
2243
+ */
2244
+ replaceWhereOverrides?: ReplaceWhereOverride[] | undefined;
2245
+ }
2246
+ export interface StartUpdateRequest_ParametersEntry {
2247
+ key?: string | undefined;
2248
+ value?: string | undefined;
2249
+ }
2250
+ export interface StartUpdateRequest_Response {
2251
+ updateId?: string | undefined;
2252
+ }
2253
+ export interface StopPipelineRequest {
2254
+ pipelineId?: string | undefined;
2255
+ }
2256
+ export interface StopPipelineRequest_Response {
2257
+ }
2258
+ /** TikTok Ads specific options for ingestion */
2259
+ export interface TikTokAdsOptions {
2260
+ /**
2261
+ * (Optional) Number of days to look back for report tables during incremental sync
2262
+ * to capture late-arriving conversions and attribution data.
2263
+ * If not specified, defaults to 7 days.
2264
+ */
2265
+ lookbackWindowDays?: number | undefined;
2266
+ /**
2267
+ * (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.
2268
+ * This determines the earliest date from which to sync historical data.
2269
+ * If not specified, defaults to 1 year of historical data for daily reports
2270
+ * and 30 days for hourly reports.
2271
+ */
2272
+ syncStartDate?: string | undefined;
2273
+ /**
2274
+ * (Optional) Dimensions to include in the report.
2275
+ * Examples: "campaign_id", "adgroup_id", "ad_id", "stat_time_day", "stat_time_hour"
2276
+ * If not specified, defaults to campaign_id.
2277
+ */
2278
+ dimensions?: string[] | undefined;
2279
+ /**
2280
+ * (Optional) Metrics to include in the report.
2281
+ * Examples: "spend", "impressions", "clicks", "conversion", "cpc"
2282
+ * If not specified, defaults to basic metrics (spend, impressions, clicks, etc.)
2283
+ */
2284
+ metrics?: string[] | undefined;
2285
+ /**
2286
+ * (Optional) Report type for the TikTok Ads API.
2287
+ * If not specified, defaults to BASIC.
2288
+ */
2289
+ reportType?: TikTokAdsOptions_TikTokReportType | undefined;
2290
+ /**
2291
+ * (Optional) Data level for the report.
2292
+ * If not specified, defaults to AUCTION_CAMPAIGN.
2293
+ */
2294
+ dataLevel?: TikTokAdsOptions_TikTokDataLevel | undefined;
2295
+ /**
2296
+ * (Optional) Whether to request lifetime metrics (all-time aggregated data).
2297
+ * When true, the report returns all-time data.
2298
+ * If not specified, defaults to false.
2299
+ */
2300
+ queryLifetime?: boolean | undefined;
2301
+ }
2302
+ /** Specifies how to transform binary data into structured data. */
2303
+ export interface Transformer {
2304
+ /** Required: the wire format of the data. */
2305
+ format?: Transformer_Format | undefined;
2306
+ /**
2307
+ * Format-specific configuration. Only required for JSON, Avro, and Protobuf.
2308
+ * STRING format requires no additional config.
2309
+ */
2310
+ config?: {
2311
+ $case: 'jsonOptions';
2312
+ jsonOptions: JsonTransformerOptions;
2313
+ } | undefined;
2314
+ }
2315
+ /** Information about truncations applied to this event. */
2316
+ export interface Truncation {
2317
+ /**
2318
+ * List of fields that were truncated from this event. If empty or absent,
2319
+ * no truncation occurred.
2320
+ */
2321
+ truncatedFields?: Truncation_TruncationDetail[] | undefined;
2322
+ }
2323
+ /** Details about a specific field that was truncated. */
2324
+ export interface Truncation_TruncationDetail {
2325
+ /**
2326
+ * The name of the truncated field (e.g., "error").
2327
+ * Corresponds to field names in PipelineEvent.
2328
+ */
2329
+ fieldName?: string | undefined;
2330
+ }
2331
+ export interface UpdateInfo {
2332
+ /** The ID of the pipeline. */
2333
+ pipelineId?: string | undefined;
2334
+ /** The ID of this update. */
2335
+ updateId?: string | undefined;
2336
+ /**
2337
+ * The pipeline configuration with system defaults applied where unspecified by the user.
2338
+ * Not returned by ListUpdates.
2339
+ */
2340
+ config?: PipelineSpec | undefined;
2341
+ /** What triggered this update. */
2342
+ cause?: UpdateCause | undefined;
2343
+ /** The update state. */
2344
+ state?: UpdateState | undefined;
2345
+ /** The ID of the cluster that the update is running on. */
2346
+ clusterId?: string | undefined;
2347
+ /** The time when this update was created. */
2348
+ creationTime?: bigint | undefined;
2349
+ /** If true, this update will reset all tables before running. */
2350
+ fullRefresh?: boolean | undefined;
2351
+ /**
2352
+ * A list of tables to update without fullRefresh. If both refresh_selection and
2353
+ * full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means
2354
+ * that the states of the table will be reset before the refresh.
2355
+ */
2356
+ refreshSelection?: string[] | undefined;
2357
+ /**
2358
+ * A list of tables to update with fullRefresh. If both refresh_selection and
2359
+ * full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means
2360
+ * that the states of the table will be reset before the refresh.
2361
+ */
2362
+ fullRefreshSelection?: string[] | undefined;
2363
+ /** If true, this update only validates the correctness of pipeline source code but does not materialize or publish any datasets. */
2364
+ validateOnly?: boolean | undefined;
2365
+ /** Key/value map of parameters used to initiate the update */
2366
+ parameters?: Record<string, string> | undefined;
2367
+ }
2368
+ export interface UpdateInfo_ParametersEntry {
2369
+ key?: string | undefined;
2370
+ value?: string | undefined;
2371
+ }
2372
+ export interface UpdateStateInfo {
2373
+ updateId?: string | undefined;
2374
+ state?: UpdateState | undefined;
2375
+ creationTime?: string | undefined;
2376
+ }
2377
+ /** Zendesk Support specific options for ingestion */
2378
+ export interface ZendeskSupportOptions {
2379
+ /**
2380
+ * (Optional) Start date in YYYY-MM-DD format for the initial sync.
2381
+ * This determines the earliest date from which to sync historical data.
2382
+ */
2383
+ startDate?: string | undefined;
2384
+ }
2385
+ export declare const unmarshalApplyEnvironmentRequest_ResponseSchema: z.ZodType<ApplyEnvironmentRequest_Response>;
2386
+ export declare const unmarshalAutoFullRefreshPolicySchema: z.ZodType<AutoFullRefreshPolicy>;
2387
+ export declare const unmarshalClonePipelineRequest_ResponseSchema: z.ZodType<ClonePipelineRequest_Response>;
2388
+ export declare const unmarshalConfluenceConnectorOptionsSchema: z.ZodType<ConfluenceConnectorOptions>;
2389
+ export declare const unmarshalConnectionParametersSchema: z.ZodType<ConnectionParameters>;
2390
+ export declare const unmarshalConnectorOptionsSchema: z.ZodType<ConnectorOptions>;
2391
+ export declare const unmarshalCreatePipelineRequest_ResponseSchema: z.ZodType<CreatePipelineRequest_Response>;
2392
+ export declare const unmarshalCronTriggerSchema: z.ZodType<CronTrigger>;
2393
+ export declare const unmarshalDataPlaneIdSchema: z.ZodType<DataPlaneId>;
2394
+ export declare const unmarshalDataStagingOptionsSchema: z.ZodType<DataStagingOptions>;
2395
+ export declare const unmarshalDeletePipelineRequest_ResponseSchema: z.ZodType<DeletePipelineRequest_Response>;
2396
+ export declare const unmarshalEditPipelineRequest_ResponseSchema: z.ZodType<EditPipelineRequest_Response>;
2397
+ export declare const unmarshalErrorDetailSchema: z.ZodType<ErrorDetail>;
2398
+ export declare const unmarshalEventLogSpecSchema: z.ZodType<EventLogSpec>;
2399
+ export declare const unmarshalFileFilterSchema: z.ZodType<FileFilter>;
2400
+ export declare const unmarshalFileIngestionOptionsSchema: z.ZodType<FileIngestionOptions>;
2401
+ export declare const unmarshalFiltersSchema: z.ZodType<Filters>;
2402
+ export declare const unmarshalGetPipelineRequest_ResponseSchema: z.ZodType<GetPipelineRequest_Response>;
2403
+ export declare const unmarshalGetUpdateRequest_ResponseSchema: z.ZodType<GetUpdateRequest_Response>;
2404
+ export declare const unmarshalGoogleAdsConfigSchema: z.ZodType<GoogleAdsConfig>;
2405
+ export declare const unmarshalGoogleAdsOptionsSchema: z.ZodType<GoogleAdsOptions>;
2406
+ export declare const unmarshalGoogleDriveOptionsSchema: z.ZodType<GoogleDriveOptions>;
2407
+ export declare const unmarshalIngestionGatewayPipelineDefinitionSchema: z.ZodType<IngestionGatewayPipelineDefinition>;
2408
+ export declare const unmarshalIngestionPipelineDefinitionSchema: z.ZodType<IngestionPipelineDefinition>;
2409
+ export declare const unmarshalIngestionPipelineDefinition_IngestionConfigSchema: z.ZodType<IngestionPipelineDefinition_IngestionConfig>;
2410
+ export declare const unmarshalIngestionPipelineDefinition_ReportSpecSchema: z.ZodType<IngestionPipelineDefinition_ReportSpec>;
2411
+ export declare const unmarshalIngestionPipelineDefinition_SchemaSpecSchema: z.ZodType<IngestionPipelineDefinition_SchemaSpec>;
2412
+ export declare const unmarshalIngestionPipelineDefinition_TableSpecSchema: z.ZodType<IngestionPipelineDefinition_TableSpec>;
2413
+ export declare const unmarshalIngestionPipelineDefinition_TableSpecificConfigSchema: z.ZodType<IngestionPipelineDefinition_TableSpecificConfig>;
2414
+ export declare const unmarshalIngestionPipelineDefinition_TableSpecificConfig_QueryBasedConnectorConfigSchema: z.ZodType<IngestionPipelineDefinition_TableSpecificConfig_QueryBasedConnectorConfig>;
2415
+ export declare const unmarshalIngestionPipelineDefinition_WorkdayReportParametersSchema: z.ZodType<IngestionPipelineDefinition_WorkdayReportParameters>;
2416
+ export declare const unmarshalIngestionPipelineDefinition_WorkdayReportParameters_QueryKeyValueSchema: z.ZodType<IngestionPipelineDefinition_WorkdayReportParameters_QueryKeyValue>;
2417
+ export declare const unmarshalJiraConnectorOptionsSchema: z.ZodType<JiraConnectorOptions>;
2418
+ export declare const unmarshalJsonTransformerOptionsSchema: z.ZodType<JsonTransformerOptions>;
2419
+ export declare const unmarshalKafkaOptionsSchema: z.ZodType<KafkaOptions>;
2420
+ export declare const unmarshalListPipelineEventsRequest_ResponseSchema: z.ZodType<ListPipelineEventsRequest_Response>;
2421
+ export declare const unmarshalListPipelinesRequest_ResponseSchema: z.ZodType<ListPipelinesRequest_Response>;
2422
+ export declare const unmarshalListUpdatesRequest_ResponseSchema: z.ZodType<ListUpdatesRequest_Response>;
2423
+ export declare const unmarshalManualTriggerSchema: z.ZodType<ManualTrigger>;
2424
+ export declare const unmarshalMetaMarketingOptionsSchema: z.ZodType<MetaMarketingOptions>;
2425
+ export declare const unmarshalNotebookLibrarySchema: z.ZodType<NotebookLibrary>;
2426
+ export declare const unmarshalNotificationsSchema: z.ZodType<Notifications>;
2427
+ export declare const unmarshalOperationTimeWindowSchema: z.ZodType<OperationTimeWindow>;
2428
+ export declare const unmarshalOriginSchema: z.ZodType<Origin>;
2429
+ export declare const unmarshalOutlookOptionsSchema: z.ZodType<OutlookOptions>;
2430
+ export declare const unmarshalPathPatternSchema: z.ZodType<PathPattern>;
2431
+ export declare const unmarshalPipelineClusterSchema: z.ZodType<PipelineCluster>;
2432
+ export declare const unmarshalPipelineDeploymentSchema: z.ZodType<PipelineDeployment>;
2433
+ export declare const unmarshalPipelineEventSchema: z.ZodType<PipelineEvent>;
2434
+ export declare const unmarshalPipelineLibrarySchema: z.ZodType<PipelineLibrary>;
2435
+ export declare const unmarshalPipelineSpecSchema: z.ZodType<PipelineSpec>;
2436
+ export declare const unmarshalPipelineStateInfoSchema: z.ZodType<PipelineStateInfo>;
2437
+ export declare const unmarshalPipelineTriggerSchema: z.ZodType<PipelineTrigger>;
2438
+ export declare const unmarshalPipelinesAutoScaleSchema: z.ZodType<PipelinesAutoScale>;
2439
+ export declare const unmarshalPipelinesAwsAttributesSchema: z.ZodType<PipelinesAwsAttributes>;
2440
+ export declare const unmarshalPipelinesAzureAttributesSchema: z.ZodType<PipelinesAzureAttributes>;
2441
+ export declare const unmarshalPipelinesClusterLogConfSchema: z.ZodType<PipelinesClusterLogConf>;
2442
+ export declare const unmarshalPipelinesDbfsStorageInfoSchema: z.ZodType<PipelinesDbfsStorageInfo>;
2443
+ export declare const unmarshalPipelinesEnvironmentSchema: z.ZodType<PipelinesEnvironment>;
2444
+ export declare const unmarshalPipelinesGcpAttributesSchema: z.ZodType<PipelinesGcpAttributes>;
2445
+ export declare const unmarshalPipelinesInitScriptInfoSchema: z.ZodType<PipelinesInitScriptInfo>;
2446
+ export declare const unmarshalPipelinesJobRunAsSchema: z.ZodType<PipelinesJobRunAs>;
2447
+ export declare const unmarshalPipelinesMavenLibrarySchema: z.ZodType<PipelinesMavenLibrary>;
2448
+ export declare const unmarshalPipelinesS3StorageInfoSchema: z.ZodType<PipelinesS3StorageInfo>;
2449
+ export declare const unmarshalPostgresCatalogConfigSchema: z.ZodType<PostgresCatalogConfig>;
2450
+ export declare const unmarshalPostgresSlotConfigSchema: z.ZodType<PostgresSlotConfig>;
2451
+ export declare const unmarshalRestartWindowSchema: z.ZodType<RestartWindow>;
2452
+ export declare const unmarshalSequencingSchema: z.ZodType<Sequencing>;
2453
+ export declare const unmarshalSerializedExceptionSchema: z.ZodType<SerializedException>;
2454
+ export declare const unmarshalSharepointOptionsSchema: z.ZodType<SharepointOptions>;
2455
+ export declare const unmarshalSmartsheetOptionsSchema: z.ZodType<SmartsheetOptions>;
2456
+ export declare const unmarshalSourceCatalogConfigSchema: z.ZodType<SourceCatalogConfig>;
2457
+ export declare const unmarshalSourceConfigSchema: z.ZodType<SourceConfig>;
2458
+ export declare const unmarshalStackFrameSchema: z.ZodType<StackFrame>;
2459
+ export declare const unmarshalStartUpdateRequest_ResponseSchema: z.ZodType<StartUpdateRequest_Response>;
2460
+ export declare const unmarshalStopPipelineRequest_ResponseSchema: z.ZodType<StopPipelineRequest_Response>;
2461
+ export declare const unmarshalTikTokAdsOptionsSchema: z.ZodType<TikTokAdsOptions>;
2462
+ export declare const unmarshalTransformerSchema: z.ZodType<Transformer>;
2463
+ export declare const unmarshalTruncationSchema: z.ZodType<Truncation>;
2464
+ export declare const unmarshalTruncation_TruncationDetailSchema: z.ZodType<Truncation_TruncationDetail>;
2465
+ export declare const unmarshalUpdateInfoSchema: z.ZodType<UpdateInfo>;
2466
+ export declare const unmarshalUpdateStateInfoSchema: z.ZodType<UpdateStateInfo>;
2467
+ export declare const unmarshalZendeskSupportOptionsSchema: z.ZodType<ZendeskSupportOptions>;
2468
+ export declare const marshalApplyEnvironmentRequestSchema: z.ZodType;
2469
+ export declare const marshalAutoFullRefreshPolicySchema: z.ZodType;
2470
+ export declare const marshalClonePipelineRequestSchema: z.ZodType;
2471
+ export declare const marshalConfluenceConnectorOptionsSchema: z.ZodType;
2472
+ export declare const marshalConnectionParametersSchema: z.ZodType;
2473
+ export declare const marshalConnectorOptionsSchema: z.ZodType;
2474
+ export declare const marshalCreatePipelineRequestSchema: z.ZodType;
2475
+ export declare const marshalCronTriggerSchema: z.ZodType;
2476
+ export declare const marshalDataStagingOptionsSchema: z.ZodType;
2477
+ export declare const marshalEditPipelineRequestSchema: z.ZodType;
2478
+ export declare const marshalEventLogSpecSchema: z.ZodType;
2479
+ export declare const marshalFileFilterSchema: z.ZodType;
2480
+ export declare const marshalFileIngestionOptionsSchema: z.ZodType;
2481
+ export declare const marshalFiltersSchema: z.ZodType;
2482
+ export declare const marshalGoogleAdsConfigSchema: z.ZodType;
2483
+ export declare const marshalGoogleAdsOptionsSchema: z.ZodType;
2484
+ export declare const marshalGoogleDriveOptionsSchema: z.ZodType;
2485
+ export declare const marshalIngestionGatewayPipelineDefinitionSchema: z.ZodType;
2486
+ export declare const marshalIngestionPipelineDefinitionSchema: z.ZodType;
2487
+ export declare const marshalIngestionPipelineDefinition_IngestionConfigSchema: z.ZodType;
2488
+ export declare const marshalIngestionPipelineDefinition_ReportSpecSchema: z.ZodType;
2489
+ export declare const marshalIngestionPipelineDefinition_SchemaSpecSchema: z.ZodType;
2490
+ export declare const marshalIngestionPipelineDefinition_TableSpecSchema: z.ZodType;
2491
+ export declare const marshalIngestionPipelineDefinition_TableSpecificConfigSchema: z.ZodType;
2492
+ export declare const marshalIngestionPipelineDefinition_TableSpecificConfig_QueryBasedConnectorConfigSchema: z.ZodType;
2493
+ export declare const marshalIngestionPipelineDefinition_WorkdayReportParametersSchema: z.ZodType;
2494
+ export declare const marshalIngestionPipelineDefinition_WorkdayReportParameters_QueryKeyValueSchema: z.ZodType;
2495
+ export declare const marshalJiraConnectorOptionsSchema: z.ZodType;
2496
+ export declare const marshalJsonTransformerOptionsSchema: z.ZodType;
2497
+ export declare const marshalKafkaOptionsSchema: z.ZodType;
2498
+ export declare const marshalManualTriggerSchema: z.ZodType;
2499
+ export declare const marshalMetaMarketingOptionsSchema: z.ZodType;
2500
+ export declare const marshalNotebookLibrarySchema: z.ZodType;
2501
+ export declare const marshalNotificationsSchema: z.ZodType;
2502
+ export declare const marshalOperationTimeWindowSchema: z.ZodType;
2503
+ export declare const marshalOutlookOptionsSchema: z.ZodType;
2504
+ export declare const marshalPathPatternSchema: z.ZodType;
2505
+ export declare const marshalPipelineClusterSchema: z.ZodType;
2506
+ export declare const marshalPipelineDeploymentSchema: z.ZodType;
2507
+ export declare const marshalPipelineLibrarySchema: z.ZodType;
2508
+ export declare const marshalPipelineTriggerSchema: z.ZodType;
2509
+ export declare const marshalPipelinesAutoScaleSchema: z.ZodType;
2510
+ export declare const marshalPipelinesAwsAttributesSchema: z.ZodType;
2511
+ export declare const marshalPipelinesAzureAttributesSchema: z.ZodType;
2512
+ export declare const marshalPipelinesClusterLogConfSchema: z.ZodType;
2513
+ export declare const marshalPipelinesDbfsStorageInfoSchema: z.ZodType;
2514
+ export declare const marshalPipelinesEnvironmentSchema: z.ZodType;
2515
+ export declare const marshalPipelinesGcpAttributesSchema: z.ZodType;
2516
+ export declare const marshalPipelinesInitScriptInfoSchema: z.ZodType;
2517
+ export declare const marshalPipelinesJobRunAsSchema: z.ZodType;
2518
+ export declare const marshalPipelinesMavenLibrarySchema: z.ZodType;
2519
+ export declare const marshalPipelinesS3StorageInfoSchema: z.ZodType;
2520
+ export declare const marshalPostgresCatalogConfigSchema: z.ZodType;
2521
+ export declare const marshalPostgresSlotConfigSchema: z.ZodType;
2522
+ export declare const marshalReplaceWhereOverrideSchema: z.ZodType;
2523
+ export declare const marshalRestartWindowSchema: z.ZodType;
2524
+ export declare const marshalRewindDatasetSpecSchema: z.ZodType;
2525
+ export declare const marshalRewindSpecSchema: z.ZodType;
2526
+ export declare const marshalSharepointOptionsSchema: z.ZodType;
2527
+ export declare const marshalSmartsheetOptionsSchema: z.ZodType;
2528
+ export declare const marshalSourceCatalogConfigSchema: z.ZodType;
2529
+ export declare const marshalSourceConfigSchema: z.ZodType;
2530
+ export declare const marshalStartUpdateRequestSchema: z.ZodType;
2531
+ export declare const marshalStopPipelineRequestSchema: z.ZodType;
2532
+ export declare const marshalTikTokAdsOptionsSchema: z.ZodType;
2533
+ export declare const marshalTransformerSchema: z.ZodType;
2534
+ export declare const marshalZendeskSupportOptionsSchema: z.ZodType;
2535
+ //# sourceMappingURL=model.d.ts.map