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

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.
@@ -1,285 +1,311 @@
1
1
  import { z } from 'zod';
2
2
  /** Enum to specify which mode of clone to execute */
3
- export declare enum CloneMode {
3
+ export declare const CloneMode: {
4
4
  /** Data and metadata are copied */
5
- MIGRATE_TO_UC = "MIGRATE_TO_UC"
6
- }
5
+ readonly MIGRATE_TO_UC: "MIGRATE_TO_UC";
6
+ };
7
+ export type CloneMode = (typeof CloneMode)[keyof typeof CloneMode] | (string & {});
7
8
  /**
8
9
  * For certain database sources LakeFlow Connect offers both query based and cdc
9
10
  * ingestion, ConnectorType can bse used to convey the type of ingestion.
10
11
  * If connection_name is provided for database sources, we default to Query Based ingestion
11
12
  */
12
- export declare enum ConnectorType {
13
- CONNECTOR_TYPE_UNSPECIFIED = "CONNECTOR_TYPE_UNSPECIFIED",
13
+ export declare const ConnectorType: {
14
+ readonly CONNECTOR_TYPE_UNSPECIFIED: "CONNECTOR_TYPE_UNSPECIFIED";
14
15
  /**
15
16
  * If connector_type = CDC and ingestion_gateway_id is provided then we use Ingestion Gateway pipeline with
16
17
  * Cdc Managed Ingestion Pipeline for ingestion, if connector_type = CDC and connection_name is provided
17
18
  * then we use Combined Cdc Managed Ingestion Pipeline.
18
19
  */
19
- CDC = "CDC",
20
- QUERY_BASED = "QUERY_BASED"
21
- }
20
+ readonly CDC: "CDC";
21
+ readonly QUERY_BASED: "QUERY_BASED";
22
+ };
23
+ export type ConnectorType = (typeof ConnectorType)[keyof typeof ConnectorType] | (string & {});
22
24
  /**
23
25
  * Days of week in which the window is allowed to happen.
24
26
  * If not specified all days of the week will be used.
25
27
  */
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
- }
28
+ export declare const DayOfWeek: {
29
+ readonly DAY_OF_WEEK_UNSPECIFIED: "DAY_OF_WEEK_UNSPECIFIED";
30
+ readonly MONDAY: "MONDAY";
31
+ readonly TUESDAY: "TUESDAY";
32
+ readonly WEDNESDAY: "WEDNESDAY";
33
+ readonly THURSDAY: "THURSDAY";
34
+ readonly FRIDAY: "FRIDAY";
35
+ readonly SATURDAY: "SATURDAY";
36
+ readonly SUNDAY: "SUNDAY";
37
+ };
38
+ export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek] | (string & {});
36
39
  /**
37
40
  * The deployment method that manages the pipeline:
38
41
  * - BUNDLE: The pipeline is managed by a Databricks Asset Bundle.
39
42
  */
40
- export declare enum DeploymentKind {
43
+ export declare const DeploymentKind: {
41
44
  /** Databricks Asset Bundle (DAB) */
42
- BUNDLE = "BUNDLE"
43
- }
45
+ readonly BUNDLE: "BUNDLE";
46
+ };
47
+ export type DeploymentKind = (typeof DeploymentKind)[keyof typeof DeploymentKind] | (string & {});
44
48
  /** 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
- }
49
+ export declare const EventLevel: {
50
+ readonly INFO: "INFO";
51
+ readonly WARN: "WARN";
52
+ readonly ERROR: "ERROR";
53
+ readonly METRICS: "METRICS";
54
+ };
55
+ export type EventLevel = (typeof EventLevel)[keyof typeof EventLevel] | (string & {});
56
+ export declare const IngestionSourceType: {
57
+ readonly INGESTION_SOURCE_TYPE_UNSPECIFIED: "INGESTION_SOURCE_TYPE_UNSPECIFIED";
58
+ readonly MYSQL: "MYSQL";
59
+ readonly POSTGRESQL: "POSTGRESQL";
60
+ readonly SQLSERVER: "SQLSERVER";
61
+ readonly SALESFORCE: "SALESFORCE";
62
+ readonly BIGQUERY: "BIGQUERY";
63
+ readonly NETSUITE: "NETSUITE";
64
+ readonly WORKDAY_RAAS: "WORKDAY_RAAS";
65
+ readonly GA4_RAW_DATA: "GA4_RAW_DATA";
66
+ readonly SERVICENOW: "SERVICENOW";
67
+ readonly MANAGED_POSTGRESQL: "MANAGED_POSTGRESQL";
68
+ readonly ORACLE: "ORACLE";
69
+ readonly TERADATA: "TERADATA";
70
+ readonly SHAREPOINT: "SHAREPOINT";
71
+ readonly DYNAMICS365: "DYNAMICS365";
72
+ readonly GOOGLE_DRIVE: "GOOGLE_DRIVE";
73
+ readonly JIRA: "JIRA";
74
+ readonly CONFLUENCE: "CONFLUENCE";
75
+ readonly META_MARKETING: "META_MARKETING";
76
+ readonly ZENDESK: "ZENDESK";
77
+ readonly FOREIGN_CATALOG: "FOREIGN_CATALOG";
78
+ };
79
+ export type IngestionSourceType = (typeof IngestionSourceType)[keyof typeof IngestionSourceType] | (string & {});
74
80
  /** Maturity level for EventDetails. */
75
- export declare enum MaturityLevel {
76
- STABLE = "STABLE",
77
- EVOLVING = "EVOLVING",
78
- DEPRECATED = "DEPRECATED"
79
- }
81
+ export declare const MaturityLevel: {
82
+ readonly STABLE: "STABLE";
83
+ readonly EVOLVING: "EVOLVING";
84
+ readonly DEPRECATED: "DEPRECATED";
85
+ };
86
+ export type MaturityLevel = (typeof MaturityLevel)[keyof typeof MaturityLevel] | (string & {});
80
87
  /** Attachment behavior mode for Outlook ingestion */
81
- export declare enum OutlookAttachmentMode {
82
- OUTLOOK_ATTACHMENT_MODE_UNSPECIFIED = "OUTLOOK_ATTACHMENT_MODE_UNSPECIFIED",
88
+ export declare const OutlookAttachmentMode: {
89
+ readonly OUTLOOK_ATTACHMENT_MODE_UNSPECIFIED: "OUTLOOK_ATTACHMENT_MODE_UNSPECIFIED";
83
90
  /** Ingest all attachments (both inline and non-inline) */
84
- ALL = "ALL",
91
+ readonly ALL: "ALL";
85
92
  /** Ingest only non-inline attachments (recommended to avoid corporate signature images) */
86
- NON_INLINE_ONLY = "NON_INLINE_ONLY",
93
+ readonly NON_INLINE_ONLY: "NON_INLINE_ONLY";
87
94
  /** Ingest only inline attachments */
88
- INLINE_ONLY = "INLINE_ONLY",
95
+ readonly INLINE_ONLY: "INLINE_ONLY";
89
96
  /** Do not ingest any attachments */
90
- NONE = "NONE"
91
- }
97
+ readonly NONE: "NONE";
98
+ };
99
+ export type OutlookAttachmentMode = (typeof OutlookAttachmentMode)[keyof typeof OutlookAttachmentMode] | (string & {});
92
100
  /** 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
- }
101
+ export declare const OutlookBodyFormat: {
102
+ readonly OUTLOOK_BODY_FORMAT_UNSPECIFIED: "OUTLOOK_BODY_FORMAT_UNSPECIFIED";
103
+ readonly TEXT_HTML: "TEXT_HTML";
104
+ readonly TEXT_PLAIN: "TEXT_PLAIN";
105
+ };
106
+ export type OutlookBodyFormat = (typeof OutlookBodyFormat)[keyof typeof OutlookBodyFormat] | (string & {});
98
107
  /** The health of a pipeline. */
99
- export declare enum PipelineHealthStatus {
100
- HEALTHY = "HEALTHY",
101
- UNHEALTHY = "UNHEALTHY"
102
- }
108
+ export declare const PipelineHealthStatus: {
109
+ readonly HEALTHY: "HEALTHY";
110
+ readonly UNHEALTHY: "UNHEALTHY";
111
+ };
112
+ export type PipelineHealthStatus = (typeof PipelineHealthStatus)[keyof typeof PipelineHealthStatus] | (string & {});
103
113
  /** The set of AWS availability types supported when setting up nodes for a cluster. */
104
- export declare enum PipelinesAwsAvailability {
114
+ export declare const PipelinesAwsAvailability: {
105
115
  /** Use spot instances. */
106
- SPOT = "SPOT",
116
+ readonly SPOT: "SPOT";
107
117
  /** Use on-demand instances. */
108
- ON_DEMAND = "ON_DEMAND",
118
+ readonly ON_DEMAND: "ON_DEMAND";
109
119
  /**
110
120
  * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
111
121
  * be acquired (e.g., if AWS spot prices are too high).
112
122
  */
113
- SPOT_WITH_FALLBACK = "SPOT_WITH_FALLBACK"
114
- }
123
+ readonly SPOT_WITH_FALLBACK: "SPOT_WITH_FALLBACK";
124
+ };
125
+ export type PipelinesAwsAvailability = (typeof PipelinesAwsAvailability)[keyof typeof PipelinesAwsAvailability] | (string & {});
115
126
  /** The set of Azure availability types supported when setting up nodes for a cluster. */
116
- export declare enum PipelinesAzureAvailability {
127
+ export declare const PipelinesAzureAvailability: {
117
128
  /** Use spot instances. */
118
- SPOT_AZURE = "SPOT_AZURE",
129
+ readonly SPOT_AZURE: "SPOT_AZURE";
119
130
  /** Use on-demand instances. */
120
- ON_DEMAND_AZURE = "ON_DEMAND_AZURE",
131
+ readonly ON_DEMAND_AZURE: "ON_DEMAND_AZURE";
121
132
  /**
122
133
  * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
123
134
  * be acquired (e.g., if Azure is out of Quota).
124
135
  */
125
- SPOT_WITH_FALLBACK_AZURE = "SPOT_WITH_FALLBACK_AZURE"
126
- }
136
+ readonly SPOT_WITH_FALLBACK_AZURE: "SPOT_WITH_FALLBACK_AZURE";
137
+ };
138
+ export type PipelinesAzureAvailability = (typeof PipelinesAzureAvailability)[keyof typeof PipelinesAzureAvailability] | (string & {});
127
139
  /**
128
140
  * All EBS volume types that <Databricks> supports.
129
141
  * See https://aws.amazon.com/ebs/details/ for details.
130
142
  */
131
- export declare enum PipelinesEbsVolumeType {
143
+ export declare const PipelinesEbsVolumeType: {
132
144
  /** Provision extra storage using AWS gp2 EBS volumes. */
133
- GENERAL_PURPOSE_SSD = "GENERAL_PURPOSE_SSD",
145
+ readonly GENERAL_PURPOSE_SSD: "GENERAL_PURPOSE_SSD";
134
146
  /** Provision extra storage using AWS st1 volumes. */
135
- THROUGHPUT_OPTIMIZED_HDD = "THROUGHPUT_OPTIMIZED_HDD"
136
- }
147
+ readonly THROUGHPUT_OPTIMIZED_HDD: "THROUGHPUT_OPTIMIZED_HDD";
148
+ };
149
+ export type PipelinesEbsVolumeType = (typeof PipelinesEbsVolumeType)[keyof typeof PipelinesEbsVolumeType] | (string & {});
137
150
  /** 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
- }
151
+ export declare const PipelinesGcpAvailability: {
152
+ readonly PREEMPTIBLE_GCP: "PREEMPTIBLE_GCP";
153
+ readonly ON_DEMAND_GCP: "ON_DEMAND_GCP";
154
+ readonly PREEMPTIBLE_WITH_FALLBACK_GCP: "PREEMPTIBLE_WITH_FALLBACK_GCP";
155
+ };
156
+ export type PipelinesGcpAvailability = (typeof PipelinesGcpAvailability)[keyof typeof PipelinesGcpAvailability] | (string & {});
143
157
  /** 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
- }
158
+ export declare const PublishingMode: {
159
+ readonly PUBLISHING_MODE_UNSPECIFIED: "PUBLISHING_MODE_UNSPECIFIED";
160
+ readonly LEGACY_PUBLISHING_MODE: "LEGACY_PUBLISHING_MODE";
161
+ readonly DEFAULT_PUBLISHING_MODE: "DEFAULT_PUBLISHING_MODE";
162
+ };
163
+ export type PublishingMode = (typeof PublishingMode)[keyof typeof PublishingMode] | (string & {});
149
164
  /** What triggered this update. */
150
- export declare enum UpdateCause {
165
+ export declare const UpdateCause: {
151
166
  /** Started through an API call. */
152
- API_CALL = "API_CALL",
167
+ readonly API_CALL: "API_CALL";
153
168
  /** Started as a retry for a failed update. */
154
- RETRY_ON_FAILURE = "RETRY_ON_FAILURE",
169
+ readonly RETRY_ON_FAILURE: "RETRY_ON_FAILURE";
155
170
  /** Started as a result of a service upgrade. */
156
- SERVICE_UPGRADE = "SERVICE_UPGRADE",
171
+ readonly SERVICE_UPGRADE: "SERVICE_UPGRADE";
157
172
  /** Started as a result of a schema change. */
158
- SCHEMA_CHANGE = "SCHEMA_CHANGE",
173
+ readonly SCHEMA_CHANGE: "SCHEMA_CHANGE";
159
174
  /** Started by the Jobs service. */
160
- JOB_TASK = "JOB_TASK",
175
+ readonly JOB_TASK: "JOB_TASK";
161
176
  /** Started by an action a user performed. */
162
- USER_ACTION = "USER_ACTION",
177
+ readonly USER_ACTION: "USER_ACTION";
163
178
  /** Started for infrastructure maintenance reason. */
164
- INFRASTRUCTURE_MAINTENANCE = "INFRASTRUCTURE_MAINTENANCE"
165
- }
179
+ readonly INFRASTRUCTURE_MAINTENANCE: "INFRASTRUCTURE_MAINTENANCE";
180
+ };
181
+ export type UpdateCause = (typeof UpdateCause)[keyof typeof UpdateCause] | (string & {});
166
182
  /** The update state. */
167
- export declare enum UpdateState {
183
+ export declare const UpdateState: {
168
184
  /** Update is waiting for previous update to finish. */
169
- QUEUED = "QUEUED",
185
+ readonly QUEUED: "QUEUED";
170
186
  /** Initial state of an update. */
171
- CREATED = "CREATED",
187
+ readonly CREATED: "CREATED";
172
188
  /** Update is waiting for clusters, jobs, or other resources. */
173
- WAITING_FOR_RESOURCES = "WAITING_FOR_RESOURCES",
189
+ readonly WAITING_FOR_RESOURCES: "WAITING_FOR_RESOURCES";
174
190
  /** Update is creating the dataflow graph. */
175
- INITIALIZING = "INITIALIZING",
191
+ readonly INITIALIZING: "INITIALIZING";
176
192
  /** Update is resetting datasets and checkpoints to the beginning. */
177
- RESETTING = "RESETTING",
193
+ readonly RESETTING: "RESETTING";
178
194
  /** If necessary, Update is creating tables or updating their schemas. */
179
- SETTING_UP_TABLES = "SETTING_UP_TABLES",
195
+ readonly SETTING_UP_TABLES: "SETTING_UP_TABLES";
180
196
  /** Update is currently executing queries. */
181
- RUNNING = "RUNNING",
197
+ readonly RUNNING: "RUNNING";
182
198
  /** Update is waiting for queries to shut down. */
183
- STOPPING = "STOPPING",
199
+ readonly STOPPING: "STOPPING";
184
200
  /** Update is complete and all necessary resources are cleaned up. */
185
- COMPLETED = "COMPLETED",
201
+ readonly COMPLETED: "COMPLETED";
186
202
  /** Update has run into an error that could not be recovered from. */
187
- FAILED = "FAILED",
203
+ readonly FAILED: "FAILED";
188
204
  /** 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
- }
205
+ readonly CANCELED: "CANCELED";
206
+ };
207
+ export type UpdateState = (typeof UpdateState)[keyof typeof UpdateState] | (string & {});
208
+ export declare const FileIngestionOptions_FileFormat: {
209
+ readonly FILE_FORMAT_UNSPECIFIED: "FILE_FORMAT_UNSPECIFIED";
210
+ readonly BINARYFILE: "BINARYFILE";
211
+ readonly JSON: "JSON";
212
+ readonly CSV: "CSV";
213
+ readonly XML: "XML";
214
+ readonly EXCEL: "EXCEL";
215
+ readonly PARQUET: "PARQUET";
216
+ readonly AVRO: "AVRO";
217
+ readonly ORC: "ORC";
218
+ };
219
+ export type FileIngestionOptions_FileFormat = (typeof FileIngestionOptions_FileFormat)[keyof typeof FileIngestionOptions_FileFormat] | (string & {});
202
220
  /** 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
- }
221
+ export declare const FileIngestionOptions_SchemaEvolutionMode: {
222
+ readonly SCHEMA_EVOLUTION_MODE_UNSPECIFIED: "SCHEMA_EVOLUTION_MODE_UNSPECIFIED";
223
+ readonly ADD_NEW_COLUMNS_WITH_TYPE_WIDENING: "ADD_NEW_COLUMNS_WITH_TYPE_WIDENING";
224
+ readonly ADD_NEW_COLUMNS: "ADD_NEW_COLUMNS";
225
+ readonly RESCUE: "RESCUE";
226
+ readonly FAIL_ON_NEW_COLUMNS: "FAIL_ON_NEW_COLUMNS";
227
+ readonly NONE: "NONE";
228
+ };
229
+ export type FileIngestionOptions_SchemaEvolutionMode = (typeof FileIngestionOptions_SchemaEvolutionMode)[keyof typeof FileIngestionOptions_SchemaEvolutionMode] | (string & {});
230
+ export declare const GoogleDriveOptions_GoogleDriveEntityType: {
231
+ readonly GOOGLE_DRIVE_ENTITY_TYPE_UNSPECIFIED: "GOOGLE_DRIVE_ENTITY_TYPE_UNSPECIFIED";
232
+ readonly FILE: "FILE";
233
+ readonly FILE_METADATA: "FILE_METADATA";
234
+ readonly PERMISSION: "PERMISSION";
235
+ };
236
+ export type GoogleDriveOptions_GoogleDriveEntityType = (typeof GoogleDriveOptions_GoogleDriveEntityType)[keyof typeof GoogleDriveOptions_GoogleDriveEntityType] | (string & {});
217
237
  /** The pipeline state. */
218
- export declare enum PipelineState_PipelineState {
238
+ export declare const PipelineState_PipelineState: {
219
239
  /** Pipeline is being deployed and waiting for clusters, jobs, or other resources */
220
- DEPLOYING = "DEPLOYING",
240
+ readonly DEPLOYING: "DEPLOYING";
221
241
  /** Pipeline is deployed but waiting for streams to start and make progress */
222
- STARTING = "STARTING",
242
+ readonly STARTING: "STARTING";
223
243
  /** Pipeline is currently executing */
224
- RUNNING = "RUNNING",
244
+ readonly RUNNING: "RUNNING";
225
245
  /** Pipeline is waiting for streams to shut down */
226
- STOPPING = "STOPPING",
246
+ readonly STOPPING: "STOPPING";
227
247
  /** All clusters, jobs, and other resources associated with the pipeline have been cleaned up */
228
- DELETED = "DELETED",
248
+ readonly DELETED: "DELETED";
229
249
  /** Pipeline has run into an error, but the daemon is attempting to fix it */
230
- RECOVERING = "RECOVERING",
250
+ readonly RECOVERING: "RECOVERING";
231
251
  /** Pipeline has run into an error that could not be recovered from */
232
- FAILED = "FAILED",
252
+ readonly FAILED: "FAILED";
233
253
  /** Pipeline is currently being reset */
234
- RESETTING = "RESETTING",
254
+ readonly RESETTING: "RESETTING";
235
255
  /** Pipeline is stopped and is not processing data. Can be resumed by calling `run` */
236
- IDLE = "IDLE"
237
- }
256
+ readonly IDLE: "IDLE";
257
+ };
258
+ export type PipelineState_PipelineState = (typeof PipelineState_PipelineState)[keyof typeof PipelineState_PipelineState] | (string & {});
238
259
  /** 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",
260
+ export declare const ScdType_ScdType: {
261
+ readonly SCD_TYPE_UNSPECIFIED: "SCD_TYPE_UNSPECIFIED";
262
+ readonly SCD_TYPE_1: "SCD_TYPE_1";
263
+ readonly SCD_TYPE_2: "SCD_TYPE_2";
243
264
  /**
244
265
  * Source data will be appended to destination table rather than merged in
245
266
  * the absence of row key.
246
267
  */
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
- }
268
+ readonly APPEND_ONLY: "APPEND_ONLY";
269
+ };
270
+ export type ScdType_ScdType = (typeof ScdType_ScdType)[keyof typeof ScdType_ScdType] | (string & {});
271
+ export declare const SharepointOptions_SharepointEntityType: {
272
+ readonly SHAREPOINT_ENTITY_TYPE_UNSPECIFIED: "SHAREPOINT_ENTITY_TYPE_UNSPECIFIED";
273
+ readonly FILE: "FILE";
274
+ readonly FILE_METADATA: "FILE_METADATA";
275
+ readonly PERMISSION: "PERMISSION";
276
+ readonly LIST: "LIST";
277
+ };
278
+ export type SharepointOptions_SharepointEntityType = (typeof SharepointOptions_SharepointEntityType)[keyof typeof SharepointOptions_SharepointEntityType] | (string & {});
256
279
  /** 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
- }
280
+ export declare const TikTokAdsOptions_TikTokDataLevel: {
281
+ readonly TIK_TOK_DATA_LEVEL_UNSPECIFIED: "TIK_TOK_DATA_LEVEL_UNSPECIFIED";
282
+ readonly AUCTION_ADVERTISER: "AUCTION_ADVERTISER";
283
+ readonly AUCTION_CAMPAIGN: "AUCTION_CAMPAIGN";
284
+ readonly AUCTION_ADGROUP: "AUCTION_ADGROUP";
285
+ readonly AUCTION_AD: "AUCTION_AD";
286
+ };
287
+ export type TikTokAdsOptions_TikTokDataLevel = (typeof TikTokAdsOptions_TikTokDataLevel)[keyof typeof TikTokAdsOptions_TikTokDataLevel] | (string & {});
264
288
  /** 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
- }
289
+ export declare const TikTokAdsOptions_TikTokReportType: {
290
+ readonly TIK_TOK_REPORT_TYPE_UNSPECIFIED: "TIK_TOK_REPORT_TYPE_UNSPECIFIED";
291
+ readonly BASIC: "BASIC";
292
+ readonly AUDIENCE: "AUDIENCE";
293
+ readonly PLAYABLE_AD: "PLAYABLE_AD";
294
+ readonly DSA: "DSA";
295
+ readonly BUSINESS_CENTER: "BUSINESS_CENTER";
296
+ readonly GMV_MAX: "GMV_MAX";
297
+ };
298
+ export type TikTokAdsOptions_TikTokReportType = (typeof TikTokAdsOptions_TikTokReportType)[keyof typeof TikTokAdsOptions_TikTokReportType] | (string & {});
299
+ export declare const Transformer_Format: {
300
+ readonly FORMAT_UNSPECIFIED: "FORMAT_UNSPECIFIED";
301
+ readonly STRING: "STRING";
302
+ readonly JSON: "JSON";
303
+ };
304
+ export type Transformer_Format = (typeof Transformer_Format)[keyof typeof Transformer_Format] | (string & {});
279
305
  export interface ApplyEnvironmentRequest {
280
306
  pipelineId?: string | undefined;
281
307
  }
282
- export interface ApplyEnvironmentRequest_Response {
308
+ export interface ApplyEnvironmentResponse {
283
309
  }
284
310
  /** Policy for auto full refresh. */
285
311
  export interface AutoFullRefreshPolicy {
@@ -375,10 +401,6 @@ export interface ClonePipelineRequest_ConfigurationEntry {
375
401
  key?: string | undefined;
376
402
  value?: string | undefined;
377
403
  }
378
- export interface ClonePipelineRequest_Response {
379
- /** The pipeline id of the cloned pipeline */
380
- pipelineId?: string | undefined;
381
- }
382
404
  /** A key-value entry that defines a single pipeline tags. */
383
405
  export interface ClonePipelineRequest_TagsEntry {
384
406
  /** Mandatory key for the tag pair. */
@@ -389,6 +411,10 @@ export interface ClonePipelineRequest_TagsEntry {
389
411
  */
390
412
  value?: string | undefined;
391
413
  }
414
+ export interface ClonePipelineResponse {
415
+ /** The pipeline id of the cloned pipeline */
416
+ pipelineId?: string | undefined;
417
+ }
392
418
  /** Confluence specific options for ingestion */
393
419
  export interface ConfluenceConnectorOptions {
394
420
  /** (Optional) Spaces to filter Confluence data on */
@@ -524,12 +550,6 @@ export interface CreatePipelineRequest_ParametersEntry {
524
550
  key?: string | undefined;
525
551
  value?: string | undefined;
526
552
  }
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
553
  /** A key-value entry that defines a single pipeline tags. */
534
554
  export interface CreatePipelineRequest_TagsEntry {
535
555
  /** Mandatory key for the tag pair. */
@@ -540,6 +560,12 @@ export interface CreatePipelineRequest_TagsEntry {
540
560
  */
541
561
  value?: string | undefined;
542
562
  }
563
+ export interface CreatePipelineResponse {
564
+ /** The unique identifier for the newly created pipeline. Only returned when dry_run is false. */
565
+ pipelineId?: string | undefined;
566
+ /** Only returned when dry_run is true. */
567
+ effectiveSettings?: PipelineSpec | undefined;
568
+ }
543
569
  export interface CronTrigger {
544
570
  quartzCronSchedule?: string | undefined;
545
571
  timezoneId?: string | undefined;
@@ -578,7 +604,7 @@ export interface DeletePipelineRequest {
578
604
  */
579
605
  cascade?: boolean | undefined;
580
606
  }
581
- export interface DeletePipelineRequest_Response {
607
+ export interface DeletePipelineResponse {
582
608
  }
583
609
  export interface EditPipelineRequest {
584
610
  /** Unique identifier for this pipeline. */
@@ -671,8 +697,6 @@ export interface EditPipelineRequest_ParametersEntry {
671
697
  key?: string | undefined;
672
698
  value?: string | undefined;
673
699
  }
674
- export interface EditPipelineRequest_Response {
675
- }
676
700
  /** A key-value entry that defines a single pipeline tags. */
677
701
  export interface EditPipelineRequest_TagsEntry {
678
702
  /** Mandatory key for the tag pair. */
@@ -683,6 +707,8 @@ export interface EditPipelineRequest_TagsEntry {
683
707
  */
684
708
  value?: string | undefined;
685
709
  }
710
+ export interface EditPipelineResponse {
711
+ }
686
712
  export interface ErrorDetail {
687
713
  /** The exception thrown for this error, with its chain of cause. */
688
714
  exceptions?: SerializedException[] | undefined;
@@ -768,7 +794,7 @@ export interface Filters {
768
794
  export interface GetPipelineRequest {
769
795
  pipelineId?: string | undefined;
770
796
  }
771
- export interface GetPipelineRequest_Response {
797
+ export interface GetPipelineResponse {
772
798
  /** The ID of the pipeline. */
773
799
  pipelineId?: string | undefined;
774
800
  /** The pipeline specification. This field is not returned when called by `ListPipelines`. */
@@ -807,7 +833,7 @@ export interface GetPipelineRequest_Response {
807
833
  */
808
834
  parameters?: Record<string, string> | undefined;
809
835
  }
810
- export interface GetPipelineRequest_Response_ParametersEntry {
836
+ export interface GetPipelineResponse_ParametersEntry {
811
837
  key?: string | undefined;
812
838
  value?: string | undefined;
813
839
  }
@@ -817,7 +843,7 @@ export interface GetUpdateRequest {
817
843
  /** The ID of the update. */
818
844
  updateId?: string | undefined;
819
845
  }
820
- export interface GetUpdateRequest_Response {
846
+ export interface GetUpdateResponse {
821
847
  /** The current update info. */
822
848
  update?: UpdateInfo | undefined;
823
849
  }
@@ -1051,6 +1077,31 @@ export interface IngestionPipelineDefinition_TableSpecificConfig {
1051
1077
  * If unspecified, auto full refresh is disabled.
1052
1078
  */
1053
1079
  autoFullRefreshPolicy?: AutoFullRefreshPolicy | undefined;
1080
+ /**
1081
+ * Table properties to set on the destination table.
1082
+ * These are key-value pairs that configure various Delta table behaviors or any user defined properties.
1083
+ * Example: {"delta.feature.variantType": "supported", "delta.enableTypeWidening": "true"}
1084
+ * Note: table_properties in table specific configuration will override the table_properties of the pipeline definition.
1085
+ */
1086
+ tableProperties?: Record<string, string> | undefined;
1087
+ /**
1088
+ * Whether to enable auto clustering on the destination table.
1089
+ * When enabled, Delta will automatically optimize the data layout
1090
+ * based on the clustering columns for improved query performance.
1091
+ * Note: enable_auto_clustering in table specific configuration will override the pipeline definition.
1092
+ * Note: we can only provide enable_auto_clustering or clustering_columns,
1093
+ * added as separate fields as we cannot have repeated field in oneof.
1094
+ */
1095
+ enableAutoClustering?: boolean | undefined;
1096
+ /**
1097
+ * List of column names to use for clustering the destination table.
1098
+ * When specified, the destination Delta table will be clustered by these columns.
1099
+ * This can improve query performance when filtering on these columns.
1100
+ * Note: clustering_columns in table specific configuration will override the pipeline definition.
1101
+ * Note: we can only provide enable_auto_clustering or clustering_columns,
1102
+ * added as separate fields as we cannot have repeated field in oneof.
1103
+ */
1104
+ clusteringColumns?: string[] | undefined;
1054
1105
  }
1055
1106
  /** Configurations that are only applicable for query-based ingestion connectors. */
1056
1107
  export interface IngestionPipelineDefinition_TableSpecificConfig_QueryBasedConnectorConfig {
@@ -1085,6 +1136,10 @@ export interface IngestionPipelineDefinition_TableSpecificConfig_QueryBasedConne
1085
1136
  */
1086
1137
  hardDeletionSyncMinIntervalInSeconds?: bigint | undefined;
1087
1138
  }
1139
+ export interface IngestionPipelineDefinition_TableSpecificConfig_TablePropertiesEntry {
1140
+ key?: string | undefined;
1141
+ value?: string | undefined;
1142
+ }
1088
1143
  export interface IngestionPipelineDefinition_WorkdayReportParameters {
1089
1144
  /**
1090
1145
  * (Optional) Marks the report as incremental.
@@ -1219,7 +1274,7 @@ export interface ListPipelineEventsRequest {
1219
1274
  */
1220
1275
  filter?: string | undefined;
1221
1276
  }
1222
- export interface ListPipelineEventsRequest_Response {
1277
+ export interface ListPipelineEventsResponse {
1223
1278
  /** The list of events matching the request criteria. */
1224
1279
  events?: PipelineEvent[] | undefined;
1225
1280
  /** If present, a token to fetch the next page of events. */
@@ -1260,7 +1315,7 @@ export interface ListPipelinesRequest {
1260
1315
  */
1261
1316
  filter?: string | undefined;
1262
1317
  }
1263
- export interface ListPipelinesRequest_Response {
1318
+ export interface ListPipelinesResponse {
1264
1319
  /** The list of events matching the request criteria. */
1265
1320
  statuses?: PipelineStateInfo[] | undefined;
1266
1321
  /** If present, a token to fetch the next page of events. */
@@ -1281,7 +1336,7 @@ export interface ListUpdatesRequest {
1281
1336
  /** If present, returns updates until and including this update_id. */
1282
1337
  untilUpdateId?: string | undefined;
1283
1338
  }
1284
- export interface ListUpdatesRequest_Response {
1339
+ export interface ListUpdatesResponse {
1285
1340
  updates?: UpdateInfo[] | undefined;
1286
1341
  /**
1287
1342
  * If present, then there are more results, and this a token to be used in a subsequent request
@@ -2247,56 +2302,35 @@ export interface StartUpdateRequest_ParametersEntry {
2247
2302
  key?: string | undefined;
2248
2303
  value?: string | undefined;
2249
2304
  }
2250
- export interface StartUpdateRequest_Response {
2305
+ export interface StartUpdateResponse {
2251
2306
  updateId?: string | undefined;
2252
2307
  }
2253
2308
  export interface StopPipelineRequest {
2254
2309
  pipelineId?: string | undefined;
2255
2310
  }
2256
- export interface StopPipelineRequest_Response {
2311
+ export interface StopPipelineResponse {
2257
2312
  }
2258
2313
  /** TikTok Ads specific options for ingestion */
2259
2314
  export interface TikTokAdsOptions {
2260
2315
  /**
2261
2316
  * (Optional) Number of days to look back for report tables during incremental sync
2262
2317
  * to capture late-arriving conversions and attribution data.
2263
- * If not specified, defaults to 7 days.
2264
2318
  */
2265
2319
  lookbackWindowDays?: number | undefined;
2266
2320
  /**
2267
2321
  * (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.
2268
2322
  * 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
2323
  */
2272
2324
  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
- */
2325
+ /** Deprecated. Use custom_report_options.dimensions instead. */
2278
2326
  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
- */
2327
+ /** Deprecated. Use custom_report_options.metrics instead. */
2284
2328
  metrics?: string[] | undefined;
2285
- /**
2286
- * (Optional) Report type for the TikTok Ads API.
2287
- * If not specified, defaults to BASIC.
2288
- */
2329
+ /** Deprecated. Use custom_report_options.report_type instead. */
2289
2330
  reportType?: TikTokAdsOptions_TikTokReportType | undefined;
2290
- /**
2291
- * (Optional) Data level for the report.
2292
- * If not specified, defaults to AUCTION_CAMPAIGN.
2293
- */
2331
+ /** Deprecated. Use custom_report_options.data_level instead. */
2294
2332
  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
- */
2333
+ /** Deprecated. Use custom_report_options.query_lifetime instead. */
2300
2334
  queryLifetime?: boolean | undefined;
2301
2335
  }
2302
2336
  /** Specifies how to transform binary data into structured data. */
@@ -2382,25 +2416,25 @@ export interface ZendeskSupportOptions {
2382
2416
  */
2383
2417
  startDate?: string | undefined;
2384
2418
  }
2385
- export declare const unmarshalApplyEnvironmentRequest_ResponseSchema: z.ZodType<ApplyEnvironmentRequest_Response>;
2419
+ export declare const unmarshalApplyEnvironmentResponseSchema: z.ZodType<ApplyEnvironmentResponse>;
2386
2420
  export declare const unmarshalAutoFullRefreshPolicySchema: z.ZodType<AutoFullRefreshPolicy>;
2387
- export declare const unmarshalClonePipelineRequest_ResponseSchema: z.ZodType<ClonePipelineRequest_Response>;
2421
+ export declare const unmarshalClonePipelineResponseSchema: z.ZodType<ClonePipelineResponse>;
2388
2422
  export declare const unmarshalConfluenceConnectorOptionsSchema: z.ZodType<ConfluenceConnectorOptions>;
2389
2423
  export declare const unmarshalConnectionParametersSchema: z.ZodType<ConnectionParameters>;
2390
2424
  export declare const unmarshalConnectorOptionsSchema: z.ZodType<ConnectorOptions>;
2391
- export declare const unmarshalCreatePipelineRequest_ResponseSchema: z.ZodType<CreatePipelineRequest_Response>;
2425
+ export declare const unmarshalCreatePipelineResponseSchema: z.ZodType<CreatePipelineResponse>;
2392
2426
  export declare const unmarshalCronTriggerSchema: z.ZodType<CronTrigger>;
2393
2427
  export declare const unmarshalDataPlaneIdSchema: z.ZodType<DataPlaneId>;
2394
2428
  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>;
2429
+ export declare const unmarshalDeletePipelineResponseSchema: z.ZodType<DeletePipelineResponse>;
2430
+ export declare const unmarshalEditPipelineResponseSchema: z.ZodType<EditPipelineResponse>;
2397
2431
  export declare const unmarshalErrorDetailSchema: z.ZodType<ErrorDetail>;
2398
2432
  export declare const unmarshalEventLogSpecSchema: z.ZodType<EventLogSpec>;
2399
2433
  export declare const unmarshalFileFilterSchema: z.ZodType<FileFilter>;
2400
2434
  export declare const unmarshalFileIngestionOptionsSchema: z.ZodType<FileIngestionOptions>;
2401
2435
  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>;
2436
+ export declare const unmarshalGetPipelineResponseSchema: z.ZodType<GetPipelineResponse>;
2437
+ export declare const unmarshalGetUpdateResponseSchema: z.ZodType<GetUpdateResponse>;
2404
2438
  export declare const unmarshalGoogleAdsConfigSchema: z.ZodType<GoogleAdsConfig>;
2405
2439
  export declare const unmarshalGoogleAdsOptionsSchema: z.ZodType<GoogleAdsOptions>;
2406
2440
  export declare const unmarshalGoogleDriveOptionsSchema: z.ZodType<GoogleDriveOptions>;
@@ -2417,9 +2451,9 @@ export declare const unmarshalIngestionPipelineDefinition_WorkdayReportParameter
2417
2451
  export declare const unmarshalJiraConnectorOptionsSchema: z.ZodType<JiraConnectorOptions>;
2418
2452
  export declare const unmarshalJsonTransformerOptionsSchema: z.ZodType<JsonTransformerOptions>;
2419
2453
  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>;
2454
+ export declare const unmarshalListPipelineEventsResponseSchema: z.ZodType<ListPipelineEventsResponse>;
2455
+ export declare const unmarshalListPipelinesResponseSchema: z.ZodType<ListPipelinesResponse>;
2456
+ export declare const unmarshalListUpdatesResponseSchema: z.ZodType<ListUpdatesResponse>;
2423
2457
  export declare const unmarshalManualTriggerSchema: z.ZodType<ManualTrigger>;
2424
2458
  export declare const unmarshalMetaMarketingOptionsSchema: z.ZodType<MetaMarketingOptions>;
2425
2459
  export declare const unmarshalNotebookLibrarySchema: z.ZodType<NotebookLibrary>;
@@ -2456,8 +2490,8 @@ export declare const unmarshalSmartsheetOptionsSchema: z.ZodType<SmartsheetOptio
2456
2490
  export declare const unmarshalSourceCatalogConfigSchema: z.ZodType<SourceCatalogConfig>;
2457
2491
  export declare const unmarshalSourceConfigSchema: z.ZodType<SourceConfig>;
2458
2492
  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>;
2493
+ export declare const unmarshalStartUpdateResponseSchema: z.ZodType<StartUpdateResponse>;
2494
+ export declare const unmarshalStopPipelineResponseSchema: z.ZodType<StopPipelineResponse>;
2461
2495
  export declare const unmarshalTikTokAdsOptionsSchema: z.ZodType<TikTokAdsOptions>;
2462
2496
  export declare const unmarshalTransformerSchema: z.ZodType<Transformer>;
2463
2497
  export declare const unmarshalTruncationSchema: z.ZodType<Truncation>;