@databricks/sdk-lakeview 0.34.0 → 0.35.0
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/dist/package.js +7 -0
- package/dist/package.js.map +1 -0
- package/dist/v1/client.d.ts +57 -53
- package/dist/v1/client.d.ts.map +1 -1
- package/dist/v1/client.js +484 -643
- package/dist/v1/client.js.map +1 -1
- package/dist/v1/index.d.ts +3 -7
- package/dist/v1/index.js +4 -7
- package/dist/v1/model.d.ts +431 -432
- package/dist/v1/model.d.ts.map +1 -1
- package/dist/v1/model.js +240 -384
- package/dist/v1/model.js.map +1 -1
- package/dist/v1/transport.d.ts +21 -17
- package/dist/v1/transport.d.ts.map +1 -1
- package/dist/v1/transport.js +60 -69
- package/dist/v1/transport.js.map +1 -1
- package/dist/v1/utils.d.ts +18 -14
- package/dist/v1/utils.d.ts.map +1 -1
- package/dist/v1/utils.js +76 -103
- package/dist/v1/utils.js.map +1 -1
- package/package.json +5 -5
- package/dist/v1/index.d.ts.map +0 -1
- package/dist/v1/index.js.map +0 -1
package/dist/v1/model.d.ts
CHANGED
|
@@ -1,440 +1,439 @@
|
|
|
1
|
-
import { Temporal } from
|
|
2
|
-
import { z } from
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
1
|
+
import { Temporal } from "@js-temporal/polyfill";
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
|
|
4
|
+
//#region src/v1/model.d.ts
|
|
5
|
+
declare const DashboardView: {
|
|
6
|
+
/** Includes summary metadata from the dashboard. */readonly DASHBOARD_VIEW_BASIC: "DASHBOARD_VIEW_BASIC";
|
|
6
7
|
};
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
/** The dashboard is in a trashed state. */
|
|
12
|
-
readonly TRASHED: "TRASHED";
|
|
8
|
+
type DashboardView = (typeof DashboardView)[keyof typeof DashboardView] | (string & {});
|
|
9
|
+
declare const LifecycleState: {
|
|
10
|
+
/** The dashboard is in an active state (not-trashed). */readonly ACTIVE: "ACTIVE"; /** The dashboard is in a trashed state. */
|
|
11
|
+
readonly TRASHED: "TRASHED";
|
|
13
12
|
};
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
13
|
+
type LifecycleState = (typeof LifecycleState)[keyof typeof LifecycleState] | (string & {});
|
|
14
|
+
declare const SchedulePauseStatus: {
|
|
15
|
+
readonly UNPAUSED: "UNPAUSED";
|
|
16
|
+
readonly PAUSED: "PAUSED";
|
|
18
17
|
};
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
}
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
}
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
}
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
}
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
}
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
18
|
+
type SchedulePauseStatus = (typeof SchedulePauseStatus)[keyof typeof SchedulePauseStatus] | (string & {});
|
|
19
|
+
interface AuthorizationDetails {
|
|
20
|
+
/**
|
|
21
|
+
* The type of authorization downscoping policy.
|
|
22
|
+
* Ex: `workspace_rule_set` defines access rules for a specific workspace resource
|
|
23
|
+
*/
|
|
24
|
+
type?: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* The resource name to which the authorization rule applies.
|
|
27
|
+
* This field is specific to `workspace_rule_set` constraint.
|
|
28
|
+
* Format: `workspaces/{workspace_id}/dashboards/{dashboard_id}`
|
|
29
|
+
*/
|
|
30
|
+
resourceName?: string | undefined;
|
|
31
|
+
/** The acl path of the tree store resource resource. */
|
|
32
|
+
resourceLegacyAclPath?: string | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* Represents downscoped permission rules with specific access rights.
|
|
35
|
+
* This field is specific to `workspace_rule_set` constraint.
|
|
36
|
+
*/
|
|
37
|
+
grantRules?: AuthorizationDetails_GrantRule[] | undefined;
|
|
38
|
+
}
|
|
39
|
+
interface AuthorizationDetails_GrantRule {
|
|
40
|
+
/**
|
|
41
|
+
* Permission sets for dashboard are defined in
|
|
42
|
+
* iam-common/rbac-common/permission-sets/definitions/TreeStoreBasePermissionSets
|
|
43
|
+
* Ex: `permissionSets/dashboard.runner`
|
|
44
|
+
*/
|
|
45
|
+
permissionSet?: string | undefined;
|
|
46
|
+
}
|
|
47
|
+
interface CreateDashboardRequest {
|
|
48
|
+
dashboard?: Dashboard | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* Sets the default catalog for all datasets in this dashboard.
|
|
51
|
+
* Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).
|
|
52
|
+
* Leave blank to keep each dataset’s existing configuration.
|
|
53
|
+
*/
|
|
54
|
+
datasetCatalog?: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Sets the default schema for all datasets in this dashboard.
|
|
57
|
+
* Does not impact table references that use fully qualified schema names (ex: nyctaxi.trips).
|
|
58
|
+
* Leave blank to keep each dataset’s existing configuration.
|
|
59
|
+
*/
|
|
60
|
+
datasetSchema?: string | undefined;
|
|
61
|
+
}
|
|
62
|
+
interface CreateScheduleRequest {
|
|
63
|
+
/** The schedule to create. A dashboard is limited to 10 schedules. */
|
|
64
|
+
schedule?: Schedule | undefined;
|
|
65
|
+
}
|
|
66
|
+
interface CreateSubscriptionRequest {
|
|
67
|
+
/** The subscription to create. A schedule is limited to 100 subscriptions. */
|
|
68
|
+
subscription?: Subscription | undefined;
|
|
69
|
+
}
|
|
70
|
+
interface CronSchedule {
|
|
71
|
+
/**
|
|
72
|
+
* A cron expression using quartz syntax. EX: `0 0 8 * * ?` represents everyday at 8am.
|
|
73
|
+
* See [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details.
|
|
74
|
+
*/
|
|
75
|
+
quartzCronExpression?: string | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* A Java timezone id. The schedule will be resolved with respect to this timezone.
|
|
78
|
+
* See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details.
|
|
79
|
+
*/
|
|
80
|
+
timezoneId?: string | undefined;
|
|
81
|
+
}
|
|
82
|
+
interface Dashboard {
|
|
83
|
+
/** UUID identifying the dashboard. */
|
|
84
|
+
dashboardId?: string | undefined;
|
|
85
|
+
/** The display name of the dashboard. */
|
|
86
|
+
displayName?: string | undefined;
|
|
87
|
+
/**
|
|
88
|
+
* The workspace path of the dashboard asset, including the file name.
|
|
89
|
+
* Exported dashboards always have the file extension `.lvdash.json`.
|
|
90
|
+
* This field is excluded in List Dashboards responses.
|
|
91
|
+
*/
|
|
92
|
+
path?: string | undefined;
|
|
93
|
+
/** The timestamp of when the dashboard was created. */
|
|
94
|
+
createTime?: Temporal.Instant | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* The timestamp of when the dashboard was last updated by the user.
|
|
97
|
+
* This field is excluded in List Dashboards responses.
|
|
98
|
+
*/
|
|
99
|
+
updateTime?: Temporal.Instant | undefined;
|
|
100
|
+
/** The warehouse ID used to run the dashboard. */
|
|
101
|
+
warehouseId?: string | undefined;
|
|
102
|
+
/**
|
|
103
|
+
* The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard
|
|
104
|
+
* has not been modified since the last read.
|
|
105
|
+
* This field is excluded in List Dashboards responses.
|
|
106
|
+
*/
|
|
107
|
+
etag?: string | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* The contents of the dashboard in serialized string form.
|
|
110
|
+
* This field is excluded in List Dashboards responses.
|
|
111
|
+
* Use the [get dashboard API](https://docs.databricks.com/api/workspace/lakeview/get)
|
|
112
|
+
* to retrieve an example response, which includes the `serialized_dashboard` field.
|
|
113
|
+
* This field provides the structure of the JSON string that represents the dashboard's
|
|
114
|
+
* layout and components.
|
|
115
|
+
*/
|
|
116
|
+
serializedDashboard?: string | undefined;
|
|
117
|
+
/** The state of the dashboard resource. Used for tracking trashed status. */
|
|
118
|
+
lifecycleState?: LifecycleState | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* The workspace path of the folder containing the dashboard. Includes leading slash and no
|
|
121
|
+
* trailing slash.
|
|
122
|
+
* This field is excluded in List Dashboards responses.
|
|
123
|
+
*/
|
|
124
|
+
parentPath?: string | undefined;
|
|
125
|
+
}
|
|
126
|
+
interface DeleteScheduleRequest {
|
|
127
|
+
/** UUID identifying the schedule. */
|
|
128
|
+
scheduleId?: string | undefined;
|
|
129
|
+
/** UUID identifying the dashboard to which the schedule belongs. */
|
|
130
|
+
dashboardId?: string | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* The etag for the schedule. Optionally, it can be provided to verify that the schedule has not
|
|
133
|
+
* been modified from its last retrieval.
|
|
134
|
+
*/
|
|
135
|
+
etag?: string | undefined;
|
|
136
|
+
}
|
|
137
|
+
interface DeleteSubscriptionRequest {
|
|
138
|
+
/** UUID identifying the subscription. */
|
|
139
|
+
subscriptionId?: string | undefined;
|
|
140
|
+
/** UUID identifying the schedule which the subscription belongs. */
|
|
141
|
+
scheduleId?: string | undefined;
|
|
142
|
+
/** UUID identifying the dashboard which the subscription belongs. */
|
|
143
|
+
dashboardId?: string | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* The etag for the subscription. Can be optionally provided to ensure that the subscription has not been
|
|
146
|
+
* modified since the last read.
|
|
147
|
+
*/
|
|
148
|
+
etag?: string | undefined;
|
|
149
|
+
}
|
|
150
|
+
interface GetDashboardRequest {
|
|
151
|
+
/** UUID identifying the dashboard. */
|
|
152
|
+
dashboardId?: string | undefined;
|
|
153
|
+
}
|
|
154
|
+
interface GetPublishedDashboardRequest {
|
|
155
|
+
/** UUID identifying the published dashboard. */
|
|
156
|
+
dashboardId?: string | undefined;
|
|
157
|
+
}
|
|
158
|
+
interface GetPublishedDashboardTokenInfoRequest {
|
|
159
|
+
/** UUID identifying the published dashboard. */
|
|
160
|
+
dashboardId?: string | undefined;
|
|
161
|
+
/** Provided external value to be included in the custom claim. */
|
|
162
|
+
externalValue?: string | undefined;
|
|
163
|
+
/** Provided external viewer id to be included in the custom claim. */
|
|
164
|
+
externalViewerId?: string | undefined;
|
|
165
|
+
}
|
|
166
|
+
interface GetPublishedDashboardTokenInfoResponse {
|
|
167
|
+
/**
|
|
168
|
+
* Custom claim generated from external_value and external_viewer_id.
|
|
169
|
+
* Format: `urn:aibi:external_data:<external_value>:<external_viewer_id>:<dashboard_id>`
|
|
170
|
+
*/
|
|
171
|
+
customClaim?: string | undefined;
|
|
172
|
+
/** Scope defining access permissions. */
|
|
173
|
+
scope?: string | undefined;
|
|
174
|
+
/**
|
|
175
|
+
* Authorization constraints for accessing the published dashboard.
|
|
176
|
+
* Currently includes `workspace_rule_set` and could be enriched with `unity_catalog_privileges` before
|
|
177
|
+
* oAuth token generation.
|
|
178
|
+
*/
|
|
179
|
+
authorizationDetails?: AuthorizationDetails[] | undefined;
|
|
180
|
+
}
|
|
181
|
+
interface GetScheduleRequest {
|
|
182
|
+
/** UUID identifying the schedule. */
|
|
183
|
+
scheduleId?: string | undefined;
|
|
184
|
+
/** UUID identifying the dashboard to which the schedule belongs. */
|
|
185
|
+
dashboardId?: string | undefined;
|
|
186
|
+
}
|
|
187
|
+
interface GetSubscriptionRequest {
|
|
188
|
+
/** UUID identifying the subscription. */
|
|
189
|
+
subscriptionId?: string | undefined;
|
|
190
|
+
/** UUID identifying the schedule which the subscription belongs. */
|
|
191
|
+
scheduleId?: string | undefined;
|
|
192
|
+
/** UUID identifying the dashboard which the subscription belongs. */
|
|
193
|
+
dashboardId?: string | undefined;
|
|
194
|
+
}
|
|
195
|
+
interface ListDashboardsRequest {
|
|
196
|
+
/** The number of dashboards to return per page. */
|
|
197
|
+
pageSize?: number | undefined;
|
|
198
|
+
/**
|
|
199
|
+
* A page token, received from a previous `ListDashboards` call.
|
|
200
|
+
* This token can be used to retrieve the subsequent page.
|
|
201
|
+
*/
|
|
202
|
+
pageToken?: string | undefined;
|
|
203
|
+
/**
|
|
204
|
+
* The flag to include dashboards located in the trash.
|
|
205
|
+
* If unspecified, only active dashboards will be returned.
|
|
206
|
+
*/
|
|
207
|
+
showTrashed?: boolean | undefined;
|
|
208
|
+
/** `DASHBOARD_VIEW_BASIC` only includes summary metadata from the dashboard. */
|
|
209
|
+
view?: DashboardView | undefined;
|
|
210
|
+
}
|
|
211
|
+
interface ListDashboardsResponse {
|
|
212
|
+
dashboards?: Dashboard[] | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* A token, which can be sent as `page_token` to retrieve the next page.
|
|
215
|
+
* If this field is omitted, there are no subsequent dashboards.
|
|
216
|
+
*/
|
|
217
|
+
nextPageToken?: string | undefined;
|
|
218
|
+
}
|
|
219
|
+
interface ListSchedulesRequest {
|
|
220
|
+
/** UUID identifying the dashboard to which the schedules belongs. */
|
|
221
|
+
dashboardId?: string | undefined;
|
|
222
|
+
/** The number of schedules to return per page. */
|
|
223
|
+
pageSize?: number | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* A page token, received from a previous `ListSchedules` call.
|
|
226
|
+
* Use this to retrieve the subsequent page.
|
|
227
|
+
*/
|
|
228
|
+
pageToken?: string | undefined;
|
|
229
|
+
}
|
|
230
|
+
interface ListSchedulesResponse {
|
|
231
|
+
schedules?: Schedule[] | undefined;
|
|
232
|
+
/**
|
|
233
|
+
* A token that can be used as a `page_token` in subsequent requests to retrieve the next page of results.
|
|
234
|
+
* If this field is omitted, there are no subsequent schedules.
|
|
235
|
+
*/
|
|
236
|
+
nextPageToken?: string | undefined;
|
|
237
|
+
}
|
|
238
|
+
interface ListSubscriptionsRequest {
|
|
239
|
+
/** UUID identifying the dashboard which the subscriptions belongs. */
|
|
240
|
+
dashboardId?: string | undefined;
|
|
241
|
+
/** UUID identifying the schedule which the subscriptions belongs. */
|
|
242
|
+
scheduleId?: string | undefined;
|
|
243
|
+
/** The number of subscriptions to return per page. */
|
|
244
|
+
pageSize?: number | undefined;
|
|
245
|
+
/**
|
|
246
|
+
* A page token, received from a previous `ListSubscriptions` call.
|
|
247
|
+
* Use this to retrieve the subsequent page.
|
|
248
|
+
*/
|
|
249
|
+
pageToken?: string | undefined;
|
|
250
|
+
}
|
|
251
|
+
interface ListSubscriptionsResponse {
|
|
252
|
+
subscriptions?: Subscription[] | undefined;
|
|
253
|
+
/**
|
|
254
|
+
* A token that can be used as a `page_token` in subsequent requests to retrieve the next page of results.
|
|
255
|
+
* If this field is omitted, there are no subsequent subscriptions.
|
|
256
|
+
*/
|
|
257
|
+
nextPageToken?: string | undefined;
|
|
258
|
+
}
|
|
259
|
+
interface MigrateDashboardRequest {
|
|
260
|
+
/** UUID of the dashboard to be migrated. */
|
|
261
|
+
sourceDashboardId?: string | undefined;
|
|
262
|
+
/** Display name for the new Lakeview dashboard. */
|
|
263
|
+
displayName?: string | undefined;
|
|
264
|
+
/** The workspace path of the folder to contain the migrated Lakeview dashboard. */
|
|
265
|
+
parentPath?: string | undefined;
|
|
266
|
+
/**
|
|
267
|
+
* Flag to indicate if mustache parameter syntax ({{ param }}) should be auto-updated
|
|
268
|
+
* to named syntax (:param) when converting datasets in the dashboard.
|
|
269
|
+
*/
|
|
270
|
+
updateParameterSyntax?: boolean | undefined;
|
|
271
|
+
}
|
|
272
|
+
interface PublishDashboardRequest {
|
|
273
|
+
/** UUID identifying the dashboard to be published. */
|
|
274
|
+
dashboardId?: string | undefined;
|
|
275
|
+
/**
|
|
276
|
+
* Flag to indicate if the publisher's credentials should be embedded in the
|
|
277
|
+
* published dashboard. These embedded credentials will be used to execute the
|
|
278
|
+
* published dashboard's queries.
|
|
279
|
+
*/
|
|
280
|
+
embedCredentials?: boolean | undefined;
|
|
281
|
+
/**
|
|
282
|
+
* The ID of the warehouse that can be used to override the warehouse which
|
|
283
|
+
* was set in the draft.
|
|
284
|
+
*/
|
|
285
|
+
warehouseId?: string | undefined;
|
|
286
|
+
}
|
|
287
|
+
interface PublishedDashboard {
|
|
288
|
+
/** The display name of the published dashboard. */
|
|
289
|
+
displayName?: string | undefined;
|
|
290
|
+
/** The warehouse ID used to run the published dashboard. */
|
|
291
|
+
warehouseId?: string | undefined;
|
|
292
|
+
/** Indicates whether credentials are embedded in the published dashboard. */
|
|
293
|
+
embedCredentials?: boolean | undefined;
|
|
294
|
+
/** The timestamp of when the published dashboard was last revised. */
|
|
295
|
+
revisionCreateTime?: Temporal.Instant | undefined;
|
|
297
296
|
}
|
|
298
297
|
/** Request to revert a dashboard draft to its last published state. */
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
298
|
+
interface RevertDashboardRequest {
|
|
299
|
+
/** UUID identifying the dashboard. */
|
|
300
|
+
dashboardId?: string | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* The etag for the dashboard. Optionally, it can be provided to verify that the dashboard
|
|
303
|
+
* has not been modified from its last retrieval.
|
|
304
|
+
*/
|
|
305
|
+
etag?: string | undefined;
|
|
307
306
|
}
|
|
308
307
|
/** Response to revert a dashboard draft to its last published state. */
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
}
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
}
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
}
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
}
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
}
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
}
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
export
|
|
308
|
+
interface RevertDashboardResponse {
|
|
309
|
+
/** The reverted dashboard. */
|
|
310
|
+
dashboard?: Dashboard | undefined;
|
|
311
|
+
}
|
|
312
|
+
interface Schedule {
|
|
313
|
+
/** UUID identifying the schedule. */
|
|
314
|
+
scheduleId?: string | undefined;
|
|
315
|
+
/** UUID identifying the dashboard to which the schedule belongs. */
|
|
316
|
+
dashboardId?: string | undefined;
|
|
317
|
+
/** The cron expression describing the frequency of the periodic refresh for this schedule. */
|
|
318
|
+
cronSchedule?: CronSchedule | undefined;
|
|
319
|
+
/** The status indicates whether this schedule is paused or not. */
|
|
320
|
+
pauseStatus?: SchedulePauseStatus | undefined;
|
|
321
|
+
/** The display name for schedule. */
|
|
322
|
+
displayName?: string | undefined;
|
|
323
|
+
/**
|
|
324
|
+
* The etag for the schedule. Must be left empty on create, must be provided on updates to ensure
|
|
325
|
+
* that the schedule has not been modified since the last read, and can be optionally provided on delete.
|
|
326
|
+
*/
|
|
327
|
+
etag?: string | undefined;
|
|
328
|
+
/** A timestamp indicating when the schedule was created. */
|
|
329
|
+
createTime?: Temporal.Instant | undefined;
|
|
330
|
+
/** A timestamp indicating when the schedule was last updated. */
|
|
331
|
+
updateTime?: Temporal.Instant | undefined;
|
|
332
|
+
/** The warehouse id to run the dashboard with for the schedule. */
|
|
333
|
+
warehouseId?: string | undefined;
|
|
334
|
+
}
|
|
335
|
+
interface Subscription {
|
|
336
|
+
/** UUID identifying the subscription. */
|
|
337
|
+
subscriptionId?: string | undefined;
|
|
338
|
+
/** UUID identifying the schedule to which the subscription belongs. */
|
|
339
|
+
scheduleId?: string | undefined;
|
|
340
|
+
/** UUID identifying the dashboard to which the subscription belongs. */
|
|
341
|
+
dashboardId?: string | undefined;
|
|
342
|
+
/** Subscriber details for users and destinations to be added as subscribers to the schedule. */
|
|
343
|
+
subscriber?: Subscription_Subscriber | undefined;
|
|
344
|
+
/** UserId of the user who adds subscribers (users or notification destinations) to the dashboard's schedule. */
|
|
345
|
+
createdByUserId?: bigint | undefined;
|
|
346
|
+
/**
|
|
347
|
+
* The etag for the subscription. Must be left empty on create, can be optionally provided on delete
|
|
348
|
+
* to ensure that the subscription has not been deleted since the last read.
|
|
349
|
+
*/
|
|
350
|
+
etag?: string | undefined;
|
|
351
|
+
/** A timestamp indicating when the subscription was created. */
|
|
352
|
+
createTime?: Temporal.Instant | undefined;
|
|
353
|
+
/** A timestamp indicating when the subscription was last updated. */
|
|
354
|
+
updateTime?: Temporal.Instant | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* Controls whether notifications are sent to the subscriber for scheduled dashboard refreshes.
|
|
357
|
+
* If not defined, defaults to false in the backend to match the current behavior (refresh and notify)
|
|
358
|
+
*/
|
|
359
|
+
skipNotify?: boolean | undefined;
|
|
360
|
+
}
|
|
361
|
+
interface Subscription_Subscriber {
|
|
362
|
+
/**
|
|
363
|
+
* The user to receive the subscription email.
|
|
364
|
+
* This parameter is mutually exclusive with `destination_subscriber`.
|
|
365
|
+
*/
|
|
366
|
+
userSubscriber?: Subscription_Subscriber_User | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* The destination to receive the subscription email.
|
|
369
|
+
* This parameter is mutually exclusive with `user_subscriber`.
|
|
370
|
+
*/
|
|
371
|
+
destinationSubscriber?: Subscription_Subscriber_Destination | undefined;
|
|
372
|
+
}
|
|
373
|
+
interface Subscription_Subscriber_Destination {
|
|
374
|
+
/** The canonical identifier of the destination to receive email notification. */
|
|
375
|
+
destinationId?: string | undefined;
|
|
376
|
+
}
|
|
377
|
+
interface Subscription_Subscriber_User {
|
|
378
|
+
/** UserId of the subscriber. */
|
|
379
|
+
userId?: bigint | undefined;
|
|
380
|
+
}
|
|
381
|
+
interface TrashDashboardRequest {
|
|
382
|
+
/** UUID identifying the dashboard. */
|
|
383
|
+
dashboardId?: string | undefined;
|
|
384
|
+
}
|
|
385
|
+
interface TrashDashboardResponse {}
|
|
386
|
+
interface UnpublishDashboardRequest {
|
|
387
|
+
/** UUID identifying the published dashboard. */
|
|
388
|
+
dashboardId?: string | undefined;
|
|
389
|
+
}
|
|
390
|
+
interface UnpublishDashboardResponse {}
|
|
391
|
+
interface UpdateDashboardRequest {
|
|
392
|
+
dashboard?: Dashboard | undefined;
|
|
393
|
+
/**
|
|
394
|
+
* Sets the default catalog for all datasets in this dashboard.
|
|
395
|
+
* Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).
|
|
396
|
+
* Leave blank to keep each dataset’s existing configuration.
|
|
397
|
+
*/
|
|
398
|
+
datasetCatalog?: string | undefined;
|
|
399
|
+
/**
|
|
400
|
+
* Sets the default schema for all datasets in this dashboard.
|
|
401
|
+
* Does not impact table references that use fully qualified schema names (ex: nyctaxi.trips).
|
|
402
|
+
* Leave blank to keep each dataset’s existing configuration.
|
|
403
|
+
*/
|
|
404
|
+
datasetSchema?: string | undefined;
|
|
405
|
+
}
|
|
406
|
+
interface UpdateScheduleRequest {
|
|
407
|
+
/** The schedule to update. */
|
|
408
|
+
schedule?: Schedule | undefined;
|
|
409
|
+
}
|
|
410
|
+
declare const unmarshalAuthorizationDetailsSchema: z.ZodType<AuthorizationDetails>;
|
|
411
|
+
declare const unmarshalAuthorizationDetails_GrantRuleSchema: z.ZodType<AuthorizationDetails_GrantRule>;
|
|
412
|
+
declare const unmarshalCronScheduleSchema: z.ZodType<CronSchedule>;
|
|
413
|
+
declare const unmarshalDashboardSchema: z.ZodType<Dashboard>;
|
|
414
|
+
declare const unmarshalGetPublishedDashboardTokenInfoResponseSchema: z.ZodType<GetPublishedDashboardTokenInfoResponse>;
|
|
415
|
+
declare const unmarshalListDashboardsResponseSchema: z.ZodType<ListDashboardsResponse>;
|
|
416
|
+
declare const unmarshalListSchedulesResponseSchema: z.ZodType<ListSchedulesResponse>;
|
|
417
|
+
declare const unmarshalListSubscriptionsResponseSchema: z.ZodType<ListSubscriptionsResponse>;
|
|
418
|
+
declare const unmarshalPublishedDashboardSchema: z.ZodType<PublishedDashboard>;
|
|
419
|
+
declare const unmarshalRevertDashboardResponseSchema: z.ZodType<RevertDashboardResponse>;
|
|
420
|
+
declare const unmarshalScheduleSchema: z.ZodType<Schedule>;
|
|
421
|
+
declare const unmarshalSubscriptionSchema: z.ZodType<Subscription>;
|
|
422
|
+
declare const unmarshalSubscription_SubscriberSchema: z.ZodType<Subscription_Subscriber>;
|
|
423
|
+
declare const unmarshalSubscription_Subscriber_DestinationSchema: z.ZodType<Subscription_Subscriber_Destination>;
|
|
424
|
+
declare const unmarshalSubscription_Subscriber_UserSchema: z.ZodType<Subscription_Subscriber_User>;
|
|
425
|
+
declare const unmarshalTrashDashboardResponseSchema: z.ZodType<TrashDashboardResponse>;
|
|
426
|
+
declare const unmarshalUnpublishDashboardResponseSchema: z.ZodType<UnpublishDashboardResponse>;
|
|
427
|
+
declare const marshalCronScheduleSchema: z.ZodType;
|
|
428
|
+
declare const marshalDashboardSchema: z.ZodType;
|
|
429
|
+
declare const marshalMigrateDashboardRequestSchema: z.ZodType;
|
|
430
|
+
declare const marshalPublishDashboardRequestSchema: z.ZodType;
|
|
431
|
+
declare const marshalRevertDashboardRequestSchema: z.ZodType;
|
|
432
|
+
declare const marshalScheduleSchema: z.ZodType;
|
|
433
|
+
declare const marshalSubscriptionSchema: z.ZodType;
|
|
434
|
+
declare const marshalSubscription_SubscriberSchema: z.ZodType;
|
|
435
|
+
declare const marshalSubscription_Subscriber_DestinationSchema: z.ZodType;
|
|
436
|
+
declare const marshalSubscription_Subscriber_UserSchema: z.ZodType;
|
|
437
|
+
//#endregion
|
|
438
|
+
export { AuthorizationDetails, AuthorizationDetails_GrantRule, CreateDashboardRequest, CreateScheduleRequest, CreateSubscriptionRequest, CronSchedule, Dashboard, DashboardView, DeleteScheduleRequest, DeleteSubscriptionRequest, GetDashboardRequest, GetPublishedDashboardRequest, GetPublishedDashboardTokenInfoRequest, GetPublishedDashboardTokenInfoResponse, GetScheduleRequest, GetSubscriptionRequest, LifecycleState, ListDashboardsRequest, ListDashboardsResponse, ListSchedulesRequest, ListSchedulesResponse, ListSubscriptionsRequest, ListSubscriptionsResponse, MigrateDashboardRequest, PublishDashboardRequest, PublishedDashboard, RevertDashboardRequest, RevertDashboardResponse, Schedule, SchedulePauseStatus, Subscription, Subscription_Subscriber, Subscription_Subscriber_Destination, Subscription_Subscriber_User, TrashDashboardRequest, TrashDashboardResponse, UnpublishDashboardRequest, UnpublishDashboardResponse, UpdateDashboardRequest, UpdateScheduleRequest, marshalCronScheduleSchema, marshalDashboardSchema, marshalMigrateDashboardRequestSchema, marshalPublishDashboardRequestSchema, marshalRevertDashboardRequestSchema, marshalScheduleSchema, marshalSubscriptionSchema, marshalSubscription_SubscriberSchema, marshalSubscription_Subscriber_DestinationSchema, marshalSubscription_Subscriber_UserSchema, unmarshalAuthorizationDetailsSchema, unmarshalAuthorizationDetails_GrantRuleSchema, unmarshalCronScheduleSchema, unmarshalDashboardSchema, unmarshalGetPublishedDashboardTokenInfoResponseSchema, unmarshalListDashboardsResponseSchema, unmarshalListSchedulesResponseSchema, unmarshalListSubscriptionsResponseSchema, unmarshalPublishedDashboardSchema, unmarshalRevertDashboardResponseSchema, unmarshalScheduleSchema, unmarshalSubscriptionSchema, unmarshalSubscription_SubscriberSchema, unmarshalSubscription_Subscriber_DestinationSchema, unmarshalSubscription_Subscriber_UserSchema, unmarshalTrashDashboardResponseSchema, unmarshalUnpublishDashboardResponseSchema };
|
|
440
439
|
//# sourceMappingURL=model.d.ts.map
|