@databricks/sdk-pipelines 0.1.0-dev.3 → 0.1.0-dev.5
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.
- package/README.md +28 -0
- package/dist/v2/client.d.ts +3 -3
- package/dist/v2/client.d.ts.map +1 -1
- package/dist/v2/client.js +71 -61
- package/dist/v2/client.js.map +1 -1
- package/dist/v2/index.d.ts +1 -1
- package/dist/v2/index.d.ts.map +1 -1
- package/dist/v2/model.d.ts +263 -333
- package/dist/v2/model.d.ts.map +1 -1
- package/dist/v2/model.js +277 -282
- package/dist/v2/model.js.map +1 -1
- package/dist/v2/transport.d.ts +30 -2
- package/dist/v2/transport.d.ts.map +1 -1
- package/dist/v2/transport.js +33 -16
- package/dist/v2/transport.js.map +1 -1
- package/dist/v2/utils.d.ts.map +1 -1
- package/dist/v2/utils.js +2 -1
- package/dist/v2/utils.js.map +1 -1
- package/package.json +9 -5
- package/src/v2/client.ts +0 -630
- package/src/v2/index.ts +0 -154
- package/src/v2/model.ts +0 -5487
- package/src/v2/transport.ts +0 -73
- package/src/v2/utils.ts +0 -180
package/dist/v2/model.d.ts
CHANGED
|
@@ -1,281 +1,307 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
/** Enum to specify which mode of clone to execute */
|
|
3
|
-
export declare
|
|
3
|
+
export declare const CloneMode: {
|
|
4
4
|
/** Data and metadata are copied */
|
|
5
|
-
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
|
|
13
|
-
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
|
|
20
|
-
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
|
|
27
|
-
DAY_OF_WEEK_UNSPECIFIED
|
|
28
|
-
MONDAY
|
|
29
|
-
TUESDAY
|
|
30
|
-
WEDNESDAY
|
|
31
|
-
THURSDAY
|
|
32
|
-
FRIDAY
|
|
33
|
-
SATURDAY
|
|
34
|
-
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
|
|
43
|
+
export declare const DeploymentKind: {
|
|
41
44
|
/** Databricks Asset Bundle (DAB) */
|
|
42
|
-
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
|
|
46
|
-
INFO
|
|
47
|
-
WARN
|
|
48
|
-
ERROR
|
|
49
|
-
METRICS
|
|
50
|
-
}
|
|
51
|
-
export
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
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
|
|
76
|
-
STABLE
|
|
77
|
-
EVOLVING
|
|
78
|
-
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
|
|
82
|
-
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
|
|
91
|
+
readonly ALL: "ALL";
|
|
85
92
|
/** Ingest only non-inline attachments (recommended to avoid corporate signature images) */
|
|
86
|
-
NON_INLINE_ONLY
|
|
93
|
+
readonly NON_INLINE_ONLY: "NON_INLINE_ONLY";
|
|
87
94
|
/** Ingest only inline attachments */
|
|
88
|
-
INLINE_ONLY
|
|
95
|
+
readonly INLINE_ONLY: "INLINE_ONLY";
|
|
89
96
|
/** Do not ingest any attachments */
|
|
90
|
-
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
|
|
94
|
-
OUTLOOK_BODY_FORMAT_UNSPECIFIED
|
|
95
|
-
TEXT_HTML
|
|
96
|
-
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
|
|
100
|
-
HEALTHY
|
|
101
|
-
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
|
|
114
|
+
export declare const PipelinesAwsAvailability: {
|
|
105
115
|
/** Use spot instances. */
|
|
106
|
-
SPOT
|
|
116
|
+
readonly SPOT: "SPOT";
|
|
107
117
|
/** Use on-demand instances. */
|
|
108
|
-
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
|
|
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
|
|
127
|
+
export declare const PipelinesAzureAvailability: {
|
|
117
128
|
/** Use spot instances. */
|
|
118
|
-
SPOT_AZURE
|
|
129
|
+
readonly SPOT_AZURE: "SPOT_AZURE";
|
|
119
130
|
/** Use on-demand instances. */
|
|
120
|
-
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
|
|
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
|
|
143
|
+
export declare const PipelinesEbsVolumeType: {
|
|
132
144
|
/** Provision extra storage using AWS gp2 EBS volumes. */
|
|
133
|
-
GENERAL_PURPOSE_SSD
|
|
145
|
+
readonly GENERAL_PURPOSE_SSD: "GENERAL_PURPOSE_SSD";
|
|
134
146
|
/** Provision extra storage using AWS st1 volumes. */
|
|
135
|
-
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
|
|
139
|
-
PREEMPTIBLE_GCP
|
|
140
|
-
ON_DEMAND_GCP
|
|
141
|
-
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
|
|
145
|
-
PUBLISHING_MODE_UNSPECIFIED
|
|
146
|
-
LEGACY_PUBLISHING_MODE
|
|
147
|
-
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
|
|
165
|
+
export declare const UpdateCause: {
|
|
151
166
|
/** Started through an API call. */
|
|
152
|
-
API_CALL
|
|
167
|
+
readonly API_CALL: "API_CALL";
|
|
153
168
|
/** Started as a retry for a failed update. */
|
|
154
|
-
RETRY_ON_FAILURE
|
|
169
|
+
readonly RETRY_ON_FAILURE: "RETRY_ON_FAILURE";
|
|
155
170
|
/** Started as a result of a service upgrade. */
|
|
156
|
-
SERVICE_UPGRADE
|
|
171
|
+
readonly SERVICE_UPGRADE: "SERVICE_UPGRADE";
|
|
157
172
|
/** Started as a result of a schema change. */
|
|
158
|
-
SCHEMA_CHANGE
|
|
173
|
+
readonly SCHEMA_CHANGE: "SCHEMA_CHANGE";
|
|
159
174
|
/** Started by the Jobs service. */
|
|
160
|
-
JOB_TASK
|
|
175
|
+
readonly JOB_TASK: "JOB_TASK";
|
|
161
176
|
/** Started by an action a user performed. */
|
|
162
|
-
USER_ACTION
|
|
177
|
+
readonly USER_ACTION: "USER_ACTION";
|
|
163
178
|
/** Started for infrastructure maintenance reason. */
|
|
164
|
-
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
|
|
183
|
+
export declare const UpdateState: {
|
|
168
184
|
/** Update is waiting for previous update to finish. */
|
|
169
|
-
QUEUED
|
|
185
|
+
readonly QUEUED: "QUEUED";
|
|
170
186
|
/** Initial state of an update. */
|
|
171
|
-
CREATED
|
|
187
|
+
readonly CREATED: "CREATED";
|
|
172
188
|
/** Update is waiting for clusters, jobs, or other resources. */
|
|
173
|
-
WAITING_FOR_RESOURCES
|
|
189
|
+
readonly WAITING_FOR_RESOURCES: "WAITING_FOR_RESOURCES";
|
|
174
190
|
/** Update is creating the dataflow graph. */
|
|
175
|
-
INITIALIZING
|
|
191
|
+
readonly INITIALIZING: "INITIALIZING";
|
|
176
192
|
/** Update is resetting datasets and checkpoints to the beginning. */
|
|
177
|
-
RESETTING
|
|
193
|
+
readonly RESETTING: "RESETTING";
|
|
178
194
|
/** If necessary, Update is creating tables or updating their schemas. */
|
|
179
|
-
SETTING_UP_TABLES
|
|
195
|
+
readonly SETTING_UP_TABLES: "SETTING_UP_TABLES";
|
|
180
196
|
/** Update is currently executing queries. */
|
|
181
|
-
RUNNING
|
|
197
|
+
readonly RUNNING: "RUNNING";
|
|
182
198
|
/** Update is waiting for queries to shut down. */
|
|
183
|
-
STOPPING
|
|
199
|
+
readonly STOPPING: "STOPPING";
|
|
184
200
|
/** Update is complete and all necessary resources are cleaned up. */
|
|
185
|
-
COMPLETED
|
|
201
|
+
readonly COMPLETED: "COMPLETED";
|
|
186
202
|
/** Update has run into an error that could not be recovered from. */
|
|
187
|
-
FAILED
|
|
203
|
+
readonly FAILED: "FAILED";
|
|
188
204
|
/** Update was canceled while it was running or queued. */
|
|
189
|
-
CANCELED
|
|
190
|
-
}
|
|
191
|
-
export
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
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
|
|
204
|
-
SCHEMA_EVOLUTION_MODE_UNSPECIFIED
|
|
205
|
-
ADD_NEW_COLUMNS_WITH_TYPE_WIDENING
|
|
206
|
-
ADD_NEW_COLUMNS
|
|
207
|
-
RESCUE
|
|
208
|
-
FAIL_ON_NEW_COLUMNS
|
|
209
|
-
NONE
|
|
210
|
-
}
|
|
211
|
-
export
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
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
|
|
238
|
+
export declare const PipelineState_PipelineState: {
|
|
219
239
|
/** Pipeline is being deployed and waiting for clusters, jobs, or other resources */
|
|
220
|
-
DEPLOYING
|
|
240
|
+
readonly DEPLOYING: "DEPLOYING";
|
|
221
241
|
/** Pipeline is deployed but waiting for streams to start and make progress */
|
|
222
|
-
STARTING
|
|
242
|
+
readonly STARTING: "STARTING";
|
|
223
243
|
/** Pipeline is currently executing */
|
|
224
|
-
RUNNING
|
|
244
|
+
readonly RUNNING: "RUNNING";
|
|
225
245
|
/** Pipeline is waiting for streams to shut down */
|
|
226
|
-
STOPPING
|
|
246
|
+
readonly STOPPING: "STOPPING";
|
|
227
247
|
/** All clusters, jobs, and other resources associated with the pipeline have been cleaned up */
|
|
228
|
-
DELETED
|
|
248
|
+
readonly DELETED: "DELETED";
|
|
229
249
|
/** Pipeline has run into an error, but the daemon is attempting to fix it */
|
|
230
|
-
RECOVERING
|
|
250
|
+
readonly RECOVERING: "RECOVERING";
|
|
231
251
|
/** Pipeline has run into an error that could not be recovered from */
|
|
232
|
-
FAILED
|
|
252
|
+
readonly FAILED: "FAILED";
|
|
233
253
|
/** Pipeline is currently being reset */
|
|
234
|
-
RESETTING
|
|
254
|
+
readonly RESETTING: "RESETTING";
|
|
235
255
|
/** Pipeline is stopped and is not processing data. Can be resumed by calling `run` */
|
|
236
|
-
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
|
|
240
|
-
SCD_TYPE_UNSPECIFIED
|
|
241
|
-
SCD_TYPE_1
|
|
242
|
-
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
|
|
248
|
-
}
|
|
249
|
-
export
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
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
|
|
258
|
-
TIK_TOK_DATA_LEVEL_UNSPECIFIED
|
|
259
|
-
AUCTION_ADVERTISER
|
|
260
|
-
AUCTION_CAMPAIGN
|
|
261
|
-
AUCTION_ADGROUP
|
|
262
|
-
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
|
|
266
|
-
TIK_TOK_REPORT_TYPE_UNSPECIFIED
|
|
267
|
-
BASIC
|
|
268
|
-
AUDIENCE
|
|
269
|
-
PLAYABLE_AD
|
|
270
|
-
DSA
|
|
271
|
-
BUSINESS_CENTER
|
|
272
|
-
GMV_MAX
|
|
273
|
-
}
|
|
274
|
-
export
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
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
|
}
|
|
@@ -370,21 +396,6 @@ export interface ClonePipelineRequest {
|
|
|
370
396
|
/** The type of clone to perform. Currently, only deep copies are supported */
|
|
371
397
|
cloneMode?: CloneMode | undefined;
|
|
372
398
|
}
|
|
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
|
-
/** A key-value entry that defines a single pipeline tags. */
|
|
379
|
-
export interface ClonePipelineRequest_TagsEntry {
|
|
380
|
-
/** Mandatory key for the tag pair. */
|
|
381
|
-
key?: string | undefined;
|
|
382
|
-
/**
|
|
383
|
-
* Optional value to be associated with the provided key.
|
|
384
|
-
* 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.
|
|
385
|
-
*/
|
|
386
|
-
value?: string | undefined;
|
|
387
|
-
}
|
|
388
399
|
export interface ClonePipelineResponse {
|
|
389
400
|
/** The pipeline id of the cloned pipeline */
|
|
390
401
|
pipelineId?: string | undefined;
|
|
@@ -515,25 +526,6 @@ export interface CreatePipelineRequest {
|
|
|
515
526
|
/** Usage policy of this pipeline. */
|
|
516
527
|
usagePolicyId?: string | undefined;
|
|
517
528
|
}
|
|
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
|
-
/** A key-value entry that defines a single pipeline tags. */
|
|
528
|
-
export interface CreatePipelineRequest_TagsEntry {
|
|
529
|
-
/** Mandatory key for the tag pair. */
|
|
530
|
-
key?: string | undefined;
|
|
531
|
-
/**
|
|
532
|
-
* Optional value to be associated with the provided key.
|
|
533
|
-
* 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.
|
|
534
|
-
*/
|
|
535
|
-
value?: string | undefined;
|
|
536
|
-
}
|
|
537
529
|
export interface CreatePipelineResponse {
|
|
538
530
|
/** The unique identifier for the newly created pipeline. Only returned when dry_run is false. */
|
|
539
531
|
pipelineId?: string | undefined;
|
|
@@ -662,25 +654,6 @@ export interface EditPipelineRequest {
|
|
|
662
654
|
/** Usage policy of this pipeline. */
|
|
663
655
|
usagePolicyId?: string | undefined;
|
|
664
656
|
}
|
|
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
|
-
/** A key-value entry that defines a single pipeline tags. */
|
|
675
|
-
export interface EditPipelineRequest_TagsEntry {
|
|
676
|
-
/** Mandatory key for the tag pair. */
|
|
677
|
-
key?: string | undefined;
|
|
678
|
-
/**
|
|
679
|
-
* Optional value to be associated with the provided key.
|
|
680
|
-
* 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.
|
|
681
|
-
*/
|
|
682
|
-
value?: string | undefined;
|
|
683
|
-
}
|
|
684
657
|
export interface EditPipelineResponse {
|
|
685
658
|
}
|
|
686
659
|
export interface ErrorDetail {
|
|
@@ -751,14 +724,6 @@ export interface FileIngestionOptions {
|
|
|
751
724
|
*/
|
|
752
725
|
formatOptions?: Record<string, string> | undefined;
|
|
753
726
|
}
|
|
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
727
|
export interface Filters {
|
|
763
728
|
/** Paths to include. */
|
|
764
729
|
include?: string[] | undefined;
|
|
@@ -807,10 +772,6 @@ export interface GetPipelineResponse {
|
|
|
807
772
|
*/
|
|
808
773
|
parameters?: Record<string, string> | undefined;
|
|
809
774
|
}
|
|
810
|
-
export interface GetPipelineResponse_ParametersEntry {
|
|
811
|
-
key?: string | undefined;
|
|
812
|
-
value?: string | undefined;
|
|
813
|
-
}
|
|
814
775
|
export interface GetUpdateRequest {
|
|
815
776
|
/** The ID of the pipeline. */
|
|
816
777
|
pipelineId?: string | undefined;
|
|
@@ -1051,6 +1012,31 @@ export interface IngestionPipelineDefinition_TableSpecificConfig {
|
|
|
1051
1012
|
* If unspecified, auto full refresh is disabled.
|
|
1052
1013
|
*/
|
|
1053
1014
|
autoFullRefreshPolicy?: AutoFullRefreshPolicy | undefined;
|
|
1015
|
+
/**
|
|
1016
|
+
* Table properties to set on the destination table.
|
|
1017
|
+
* These are key-value pairs that configure various Delta table behaviors or any user defined properties.
|
|
1018
|
+
* Example: {"delta.feature.variantType": "supported", "delta.enableTypeWidening": "true"}
|
|
1019
|
+
* Note: table_properties in table specific configuration will override the table_properties of the pipeline definition.
|
|
1020
|
+
*/
|
|
1021
|
+
tableProperties?: Record<string, string> | undefined;
|
|
1022
|
+
/**
|
|
1023
|
+
* Whether to enable auto clustering on the destination table.
|
|
1024
|
+
* When enabled, Delta will automatically optimize the data layout
|
|
1025
|
+
* based on the clustering columns for improved query performance.
|
|
1026
|
+
* Note: enable_auto_clustering in table specific configuration will override the pipeline definition.
|
|
1027
|
+
* Note: we can only provide enable_auto_clustering or clustering_columns,
|
|
1028
|
+
* added as separate fields as we cannot have repeated field in oneof.
|
|
1029
|
+
*/
|
|
1030
|
+
enableAutoClustering?: boolean | undefined;
|
|
1031
|
+
/**
|
|
1032
|
+
* List of column names to use for clustering the destination table.
|
|
1033
|
+
* When specified, the destination Delta table will be clustered by these columns.
|
|
1034
|
+
* This can improve query performance when filtering on these columns.
|
|
1035
|
+
* Note: clustering_columns in table specific configuration will override the pipeline definition.
|
|
1036
|
+
* Note: we can only provide enable_auto_clustering or clustering_columns,
|
|
1037
|
+
* added as separate fields as we cannot have repeated field in oneof.
|
|
1038
|
+
*/
|
|
1039
|
+
clusteringColumns?: string[] | undefined;
|
|
1054
1040
|
}
|
|
1055
1041
|
/** Configurations that are only applicable for query-based ingestion connectors. */
|
|
1056
1042
|
export interface IngestionPipelineDefinition_TableSpecificConfig_QueryBasedConnectorConfig {
|
|
@@ -1108,11 +1094,6 @@ export interface IngestionPipelineDefinition_WorkdayReportParameters {
|
|
|
1108
1094
|
*/
|
|
1109
1095
|
parameters?: Record<string, string> | undefined;
|
|
1110
1096
|
}
|
|
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
1097
|
export interface IngestionPipelineDefinition_WorkdayReportParameters_QueryKeyValue {
|
|
1117
1098
|
/** Key for the report parameter, can be a column name or other metadata */
|
|
1118
1099
|
key?: string | undefined;
|
|
@@ -1177,10 +1158,6 @@ export interface KafkaOptions {
|
|
|
1177
1158
|
*/
|
|
1178
1159
|
clientConfig?: Record<string, string> | undefined;
|
|
1179
1160
|
}
|
|
1180
|
-
export interface KafkaOptions_ClientConfigEntry {
|
|
1181
|
-
key?: string | undefined;
|
|
1182
|
-
value?: string | undefined;
|
|
1183
|
-
}
|
|
1184
1161
|
/**
|
|
1185
1162
|
* The request/response messages for the ListPipelines API. The default behavior is to return
|
|
1186
1163
|
* the 25 newest events in timestamp descending order for the given pipeline.
|
|
@@ -1295,27 +1272,39 @@ export interface ManualTrigger {
|
|
|
1295
1272
|
}
|
|
1296
1273
|
/** Meta Marketing (Meta Ads) specific options for ingestion */
|
|
1297
1274
|
export interface MetaMarketingOptions {
|
|
1298
|
-
/**
|
|
1275
|
+
/**
|
|
1276
|
+
* (Optional, DEPRECATED — use custom_report_options.level) Granularity of data to pull
|
|
1277
|
+
* (account, ad, adset, campaign)
|
|
1278
|
+
*/
|
|
1299
1279
|
level?: string | undefined;
|
|
1300
|
-
/** (Optional) Breakdowns to configure
|
|
1280
|
+
/** (Optional, DEPRECATED — use custom_report_options.breakdowns) Breakdowns to configure */
|
|
1301
1281
|
breakdowns?: string[] | undefined;
|
|
1302
|
-
/** (Optional
|
|
1282
|
+
/** (Optional, DEPRECATED — use custom_report_options.action_breakdowns) Action breakdowns */
|
|
1303
1283
|
actionBreakdowns?: string[] | undefined;
|
|
1304
|
-
/**
|
|
1284
|
+
/**
|
|
1285
|
+
* (Optional, DEPRECATED — use custom_report_options.action_report_time) Timing used to report
|
|
1286
|
+
* action statistics (impression, conversion, mixed, or lifetime)
|
|
1287
|
+
*/
|
|
1305
1288
|
actionReportTime?: string | undefined;
|
|
1306
1289
|
/**
|
|
1307
1290
|
* (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added
|
|
1308
|
-
* after this date will be ingested
|
|
1291
|
+
* after this date will be ingested, shared by prebuilt and custom reports.
|
|
1309
1292
|
*/
|
|
1310
1293
|
startDate?: string | undefined;
|
|
1311
1294
|
/**
|
|
1312
1295
|
* (Optional) Window in days to revisit data during sync to capture
|
|
1313
|
-
* updated conversion data from the API.
|
|
1296
|
+
* updated conversion data from the API, shared by prebuilt and custom reports.
|
|
1314
1297
|
*/
|
|
1315
1298
|
customInsightsLookbackWindow?: number | undefined;
|
|
1316
|
-
/**
|
|
1299
|
+
/**
|
|
1300
|
+
* (Optional, DEPRECATED — use custom_report_options.time_increment) Value in string by which to
|
|
1301
|
+
* aggregate statistics (can take all_days, monthly or number of days)
|
|
1302
|
+
*/
|
|
1317
1303
|
timeIncrement?: string | undefined;
|
|
1318
|
-
/**
|
|
1304
|
+
/**
|
|
1305
|
+
* (Optional, DEPRECATED — use custom_report_options.action_attribution_windows) Action attribution
|
|
1306
|
+
* windows for insights reporting (e.g. "28d_click", "1d_view")
|
|
1307
|
+
*/
|
|
1319
1308
|
actionAttributionWindows?: string[] | undefined;
|
|
1320
1309
|
}
|
|
1321
1310
|
export interface NotebookLibrary {
|
|
@@ -1570,21 +1559,6 @@ export interface PipelineCluster {
|
|
|
1570
1559
|
autoscale: PipelinesAutoScale;
|
|
1571
1560
|
} | undefined;
|
|
1572
1561
|
}
|
|
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
1562
|
export interface PipelineDeployment {
|
|
1589
1563
|
/** The deployment method that manages the pipeline. */
|
|
1590
1564
|
kind?: DeploymentKind | undefined;
|
|
@@ -1727,21 +1701,6 @@ export interface PipelineSpec {
|
|
|
1727
1701
|
/** Usage policy of this pipeline. */
|
|
1728
1702
|
usagePolicyId?: string | undefined;
|
|
1729
1703
|
}
|
|
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
1704
|
export interface PipelineState {
|
|
1746
1705
|
}
|
|
1747
1706
|
export interface PipelineStateInfo {
|
|
@@ -2243,10 +2202,6 @@ export interface StartUpdateRequest {
|
|
|
2243
2202
|
*/
|
|
2244
2203
|
replaceWhereOverrides?: ReplaceWhereOverride[] | undefined;
|
|
2245
2204
|
}
|
|
2246
|
-
export interface StartUpdateRequest_ParametersEntry {
|
|
2247
|
-
key?: string | undefined;
|
|
2248
|
-
value?: string | undefined;
|
|
2249
|
-
}
|
|
2250
2205
|
export interface StartUpdateResponse {
|
|
2251
2206
|
updateId?: string | undefined;
|
|
2252
2207
|
}
|
|
@@ -2260,43 +2215,22 @@ export interface TikTokAdsOptions {
|
|
|
2260
2215
|
/**
|
|
2261
2216
|
* (Optional) Number of days to look back for report tables during incremental sync
|
|
2262
2217
|
* to capture late-arriving conversions and attribution data.
|
|
2263
|
-
* If not specified, defaults to 7 days.
|
|
2264
2218
|
*/
|
|
2265
2219
|
lookbackWindowDays?: number | undefined;
|
|
2266
2220
|
/**
|
|
2267
2221
|
* (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.
|
|
2268
2222
|
* 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
2223
|
*/
|
|
2272
2224
|
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
|
-
*/
|
|
2225
|
+
/** Deprecated. Use custom_report_options.dimensions instead. */
|
|
2278
2226
|
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
|
-
*/
|
|
2227
|
+
/** Deprecated. Use custom_report_options.metrics instead. */
|
|
2284
2228
|
metrics?: string[] | undefined;
|
|
2285
|
-
/**
|
|
2286
|
-
* (Optional) Report type for the TikTok Ads API.
|
|
2287
|
-
* If not specified, defaults to BASIC.
|
|
2288
|
-
*/
|
|
2229
|
+
/** Deprecated. Use custom_report_options.report_type instead. */
|
|
2289
2230
|
reportType?: TikTokAdsOptions_TikTokReportType | undefined;
|
|
2290
|
-
/**
|
|
2291
|
-
* (Optional) Data level for the report.
|
|
2292
|
-
* If not specified, defaults to AUCTION_CAMPAIGN.
|
|
2293
|
-
*/
|
|
2231
|
+
/** Deprecated. Use custom_report_options.data_level instead. */
|
|
2294
2232
|
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
|
-
*/
|
|
2233
|
+
/** Deprecated. Use custom_report_options.query_lifetime instead. */
|
|
2300
2234
|
queryLifetime?: boolean | undefined;
|
|
2301
2235
|
}
|
|
2302
2236
|
/** Specifies how to transform binary data into structured data. */
|
|
@@ -2365,10 +2299,6 @@ export interface UpdateInfo {
|
|
|
2365
2299
|
/** Key/value map of parameters used to initiate the update */
|
|
2366
2300
|
parameters?: Record<string, string> | undefined;
|
|
2367
2301
|
}
|
|
2368
|
-
export interface UpdateInfo_ParametersEntry {
|
|
2369
|
-
key?: string | undefined;
|
|
2370
|
-
value?: string | undefined;
|
|
2371
|
-
}
|
|
2372
2302
|
export interface UpdateStateInfo {
|
|
2373
2303
|
updateId?: string | undefined;
|
|
2374
2304
|
state?: UpdateState | undefined;
|