@databricks/sdk-dataquality 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.
@@ -1,505 +1,480 @@
1
- import { FieldMask } from '@databricks/sdk-core/wkt';
2
- import { z } from 'zod';
1
+ import { FieldMask } from "@databricks/sdk-core/wkt";
2
+ import { z } from "zod";
3
+
4
+ //#region src/v1/model.d.ts
3
5
  /** The granularity for aggregating data into time windows based on their timestamp. */
4
- export declare const AggregationGranularity: {
5
- readonly AGGREGATION_GRANULARITY_UNSPECIFIED: "AGGREGATION_GRANULARITY_UNSPECIFIED";
6
- /** 5 minutes. */
7
- readonly AGGREGATION_GRANULARITY_5_MINUTES: "AGGREGATION_GRANULARITY_5_MINUTES";
8
- /** 30 minutes. */
9
- readonly AGGREGATION_GRANULARITY_30_MINUTES: "AGGREGATION_GRANULARITY_30_MINUTES";
10
- /** 1 hour. */
11
- readonly AGGREGATION_GRANULARITY_1_HOUR: "AGGREGATION_GRANULARITY_1_HOUR";
12
- /** 1 day. */
13
- readonly AGGREGATION_GRANULARITY_1_DAY: "AGGREGATION_GRANULARITY_1_DAY";
14
- /** 1 week. */
15
- readonly AGGREGATION_GRANULARITY_1_WEEK: "AGGREGATION_GRANULARITY_1_WEEK";
16
- /** 2 weeks. */
17
- readonly AGGREGATION_GRANULARITY_2_WEEKS: "AGGREGATION_GRANULARITY_2_WEEKS";
18
- /** 3 weeks. */
19
- readonly AGGREGATION_GRANULARITY_3_WEEKS: "AGGREGATION_GRANULARITY_3_WEEKS";
20
- /** 4 weeks. */
21
- readonly AGGREGATION_GRANULARITY_4_WEEKS: "AGGREGATION_GRANULARITY_4_WEEKS";
22
- /** 1 month. */
23
- readonly AGGREGATION_GRANULARITY_1_MONTH: "AGGREGATION_GRANULARITY_1_MONTH";
24
- /** 1 year. */
25
- readonly AGGREGATION_GRANULARITY_1_YEAR: "AGGREGATION_GRANULARITY_1_YEAR";
6
+ declare const AggregationGranularity: {
7
+ readonly AGGREGATION_GRANULARITY_UNSPECIFIED: "AGGREGATION_GRANULARITY_UNSPECIFIED"; /** 5 minutes. */
8
+ readonly AGGREGATION_GRANULARITY_5_MINUTES: "AGGREGATION_GRANULARITY_5_MINUTES"; /** 30 minutes. */
9
+ readonly AGGREGATION_GRANULARITY_30_MINUTES: "AGGREGATION_GRANULARITY_30_MINUTES"; /** 1 hour. */
10
+ readonly AGGREGATION_GRANULARITY_1_HOUR: "AGGREGATION_GRANULARITY_1_HOUR"; /** 1 day. */
11
+ readonly AGGREGATION_GRANULARITY_1_DAY: "AGGREGATION_GRANULARITY_1_DAY"; /** 1 week. */
12
+ readonly AGGREGATION_GRANULARITY_1_WEEK: "AGGREGATION_GRANULARITY_1_WEEK"; /** 2 weeks. */
13
+ readonly AGGREGATION_GRANULARITY_2_WEEKS: "AGGREGATION_GRANULARITY_2_WEEKS"; /** 3 weeks. */
14
+ readonly AGGREGATION_GRANULARITY_3_WEEKS: "AGGREGATION_GRANULARITY_3_WEEKS"; /** 4 weeks. */
15
+ readonly AGGREGATION_GRANULARITY_4_WEEKS: "AGGREGATION_GRANULARITY_4_WEEKS"; /** 1 month. */
16
+ readonly AGGREGATION_GRANULARITY_1_MONTH: "AGGREGATION_GRANULARITY_1_MONTH"; /** 1 year. */
17
+ readonly AGGREGATION_GRANULARITY_1_YEAR: "AGGREGATION_GRANULARITY_1_YEAR";
26
18
  };
27
- export type AggregationGranularity = (typeof AggregationGranularity)[keyof typeof AggregationGranularity] | (string & {});
19
+ type AggregationGranularity = (typeof AggregationGranularity)[keyof typeof AggregationGranularity] | (string & {});
28
20
  /** The data quality monitoring workflow cron schedule pause status. */
29
- export declare const CronSchedulePauseStatus: {
30
- readonly CRON_SCHEDULE_PAUSE_STATUS_UNSPECIFIED: "CRON_SCHEDULE_PAUSE_STATUS_UNSPECIFIED";
31
- /** The cron schedule is not paused. */
32
- readonly CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED: "CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED";
33
- /** The cron schedule is paused. */
34
- readonly CRON_SCHEDULE_PAUSE_STATUS_PAUSED: "CRON_SCHEDULE_PAUSE_STATUS_PAUSED";
21
+ declare const CronSchedulePauseStatus: {
22
+ readonly CRON_SCHEDULE_PAUSE_STATUS_UNSPECIFIED: "CRON_SCHEDULE_PAUSE_STATUS_UNSPECIFIED"; /** The cron schedule is not paused. */
23
+ readonly CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED: "CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED"; /** The cron schedule is paused. */
24
+ readonly CRON_SCHEDULE_PAUSE_STATUS_PAUSED: "CRON_SCHEDULE_PAUSE_STATUS_PAUSED";
35
25
  };
36
- export type CronSchedulePauseStatus = (typeof CronSchedulePauseStatus)[keyof typeof CronSchedulePauseStatus] | (string & {});
26
+ type CronSchedulePauseStatus = (typeof CronSchedulePauseStatus)[keyof typeof CronSchedulePauseStatus] | (string & {});
37
27
  /** The custom metric type. */
38
- export declare const DataProfilingCustomMetricType: {
39
- readonly DATA_PROFILING_CUSTOM_METRIC_TYPE_UNSPECIFIED: "DATA_PROFILING_CUSTOM_METRIC_TYPE_UNSPECIFIED";
40
- /** Only depend on the existing columns in the table. */
41
- readonly DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE: "DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE";
42
- /** Only depend on previously computed aggregate metrics. */
43
- readonly DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED: "DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED";
44
- /** Depend on previously computed aggregate or derived metrics. */
45
- readonly DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT: "DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT";
28
+ declare const DataProfilingCustomMetricType: {
29
+ readonly DATA_PROFILING_CUSTOM_METRIC_TYPE_UNSPECIFIED: "DATA_PROFILING_CUSTOM_METRIC_TYPE_UNSPECIFIED"; /** Only depend on the existing columns in the table. */
30
+ readonly DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE: "DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE"; /** Only depend on previously computed aggregate metrics. */
31
+ readonly DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED: "DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED"; /** Depend on previously computed aggregate or derived metrics. */
32
+ readonly DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT: "DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT";
46
33
  };
47
- export type DataProfilingCustomMetricType = (typeof DataProfilingCustomMetricType)[keyof typeof DataProfilingCustomMetricType] | (string & {});
34
+ type DataProfilingCustomMetricType = (typeof DataProfilingCustomMetricType)[keyof typeof DataProfilingCustomMetricType] | (string & {});
48
35
  /** The status of the data profiling monitor. */
49
- export declare const DataProfilingStatus: {
50
- readonly DATA_PROFILING_STATUS_UNSPECIFIED: "DATA_PROFILING_STATUS_UNSPECIFIED";
51
- readonly DATA_PROFILING_STATUS_ACTIVE: "DATA_PROFILING_STATUS_ACTIVE";
52
- readonly DATA_PROFILING_STATUS_PENDING: "DATA_PROFILING_STATUS_PENDING";
53
- readonly DATA_PROFILING_STATUS_DELETE_PENDING: "DATA_PROFILING_STATUS_DELETE_PENDING";
54
- readonly DATA_PROFILING_STATUS_ERROR: "DATA_PROFILING_STATUS_ERROR";
55
- readonly DATA_PROFILING_STATUS_FAILED: "DATA_PROFILING_STATUS_FAILED";
36
+ declare const DataProfilingStatus: {
37
+ readonly DATA_PROFILING_STATUS_UNSPECIFIED: "DATA_PROFILING_STATUS_UNSPECIFIED";
38
+ readonly DATA_PROFILING_STATUS_ACTIVE: "DATA_PROFILING_STATUS_ACTIVE";
39
+ readonly DATA_PROFILING_STATUS_PENDING: "DATA_PROFILING_STATUS_PENDING";
40
+ readonly DATA_PROFILING_STATUS_DELETE_PENDING: "DATA_PROFILING_STATUS_DELETE_PENDING";
41
+ readonly DATA_PROFILING_STATUS_ERROR: "DATA_PROFILING_STATUS_ERROR";
42
+ readonly DATA_PROFILING_STATUS_FAILED: "DATA_PROFILING_STATUS_FAILED";
56
43
  };
57
- export type DataProfilingStatus = (typeof DataProfilingStatus)[keyof typeof DataProfilingStatus] | (string & {});
44
+ type DataProfilingStatus = (typeof DataProfilingStatus)[keyof typeof DataProfilingStatus] | (string & {});
58
45
  /** Inference problem type the model aims to solve. */
59
- export declare const InferenceProblemType: {
60
- readonly INFERENCE_PROBLEM_TYPE_UNSPECIFIED: "INFERENCE_PROBLEM_TYPE_UNSPECIFIED";
61
- /** Classification inference problem. */
62
- readonly INFERENCE_PROBLEM_TYPE_CLASSIFICATION: "INFERENCE_PROBLEM_TYPE_CLASSIFICATION";
63
- /** Regression inference problem. */
64
- readonly INFERENCE_PROBLEM_TYPE_REGRESSION: "INFERENCE_PROBLEM_TYPE_REGRESSION";
46
+ declare const InferenceProblemType: {
47
+ readonly INFERENCE_PROBLEM_TYPE_UNSPECIFIED: "INFERENCE_PROBLEM_TYPE_UNSPECIFIED"; /** Classification inference problem. */
48
+ readonly INFERENCE_PROBLEM_TYPE_CLASSIFICATION: "INFERENCE_PROBLEM_TYPE_CLASSIFICATION"; /** Regression inference problem. */
49
+ readonly INFERENCE_PROBLEM_TYPE_REGRESSION: "INFERENCE_PROBLEM_TYPE_REGRESSION";
65
50
  };
66
- export type InferenceProblemType = (typeof InferenceProblemType)[keyof typeof InferenceProblemType] | (string & {});
51
+ type InferenceProblemType = (typeof InferenceProblemType)[keyof typeof InferenceProblemType] | (string & {});
67
52
  /** The state of the refresh. */
68
- export declare const RefreshState: {
69
- readonly MONITOR_REFRESH_STATE_UNKNOWN: "MONITOR_REFRESH_STATE_UNKNOWN";
70
- /** The refresh is pending. */
71
- readonly MONITOR_REFRESH_STATE_PENDING: "MONITOR_REFRESH_STATE_PENDING";
72
- /** The refresh is running. */
73
- readonly MONITOR_REFRESH_STATE_RUNNING: "MONITOR_REFRESH_STATE_RUNNING";
74
- /** The refresh is successful. */
75
- readonly MONITOR_REFRESH_STATE_SUCCESS: "MONITOR_REFRESH_STATE_SUCCESS";
76
- /** The refresh has failed. */
77
- readonly MONITOR_REFRESH_STATE_FAILED: "MONITOR_REFRESH_STATE_FAILED";
78
- /** The refresh is cancelled. */
79
- readonly MONITOR_REFRESH_STATE_CANCELED: "MONITOR_REFRESH_STATE_CANCELED";
53
+ declare const RefreshState: {
54
+ readonly MONITOR_REFRESH_STATE_UNKNOWN: "MONITOR_REFRESH_STATE_UNKNOWN"; /** The refresh is pending. */
55
+ readonly MONITOR_REFRESH_STATE_PENDING: "MONITOR_REFRESH_STATE_PENDING"; /** The refresh is running. */
56
+ readonly MONITOR_REFRESH_STATE_RUNNING: "MONITOR_REFRESH_STATE_RUNNING"; /** The refresh is successful. */
57
+ readonly MONITOR_REFRESH_STATE_SUCCESS: "MONITOR_REFRESH_STATE_SUCCESS"; /** The refresh has failed. */
58
+ readonly MONITOR_REFRESH_STATE_FAILED: "MONITOR_REFRESH_STATE_FAILED"; /** The refresh is cancelled. */
59
+ readonly MONITOR_REFRESH_STATE_CANCELED: "MONITOR_REFRESH_STATE_CANCELED";
80
60
  };
81
- export type RefreshState = (typeof RefreshState)[keyof typeof RefreshState] | (string & {});
61
+ type RefreshState = (typeof RefreshState)[keyof typeof RefreshState] | (string & {});
82
62
  /** The trigger of the refresh. */
83
- export declare const RefreshTrigger: {
84
- readonly MONITOR_REFRESH_TRIGGER_UNKNOWN: "MONITOR_REFRESH_TRIGGER_UNKNOWN";
85
- /** The refresh has been triggered manually. */
86
- readonly MONITOR_REFRESH_TRIGGER_MANUAL: "MONITOR_REFRESH_TRIGGER_MANUAL";
87
- /** The refresh has been triggered from a schedule. */
88
- readonly MONITOR_REFRESH_TRIGGER_SCHEDULE: "MONITOR_REFRESH_TRIGGER_SCHEDULE";
89
- /** The refresh has been triggered from a data change. */
90
- readonly MONITOR_REFRESH_TRIGGER_DATA_CHANGE: "MONITOR_REFRESH_TRIGGER_DATA_CHANGE";
63
+ declare const RefreshTrigger: {
64
+ readonly MONITOR_REFRESH_TRIGGER_UNKNOWN: "MONITOR_REFRESH_TRIGGER_UNKNOWN"; /** The refresh has been triggered manually. */
65
+ readonly MONITOR_REFRESH_TRIGGER_MANUAL: "MONITOR_REFRESH_TRIGGER_MANUAL"; /** The refresh has been triggered from a schedule. */
66
+ readonly MONITOR_REFRESH_TRIGGER_SCHEDULE: "MONITOR_REFRESH_TRIGGER_SCHEDULE"; /** The refresh has been triggered from a data change. */
67
+ readonly MONITOR_REFRESH_TRIGGER_DATA_CHANGE: "MONITOR_REFRESH_TRIGGER_DATA_CHANGE";
91
68
  };
92
- export type RefreshTrigger = (typeof RefreshTrigger)[keyof typeof RefreshTrigger] | (string & {});
69
+ type RefreshTrigger = (typeof RefreshTrigger)[keyof typeof RefreshTrigger] | (string & {});
93
70
  /** Anomaly Detection Configurations. */
94
- export interface AnomalyDetectionConfig {
95
- /** List of fully qualified table names to exclude from anomaly detection. */
96
- excludedTableFullNames?: string[] | undefined;
71
+ interface AnomalyDetectionConfig {
72
+ /** List of fully qualified table names to exclude from anomaly detection. */
73
+ excludedTableFullNames?: string[] | undefined;
97
74
  }
98
75
  /** Request to cancel a refresh. */
99
- export interface CancelRefreshRequest {
100
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
101
- objectType?: string | undefined;
102
- /**
103
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
104
- *
105
- * Find the `schema_id` from either:
106
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
107
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
108
- *
109
- * Find the `table_id` from either:
110
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
111
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
112
- */
113
- objectId?: string | undefined;
114
- /** Unique id of the refresh operation. */
115
- refreshId?: bigint | undefined;
76
+ interface CancelRefreshRequest {
77
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
78
+ objectType?: string | undefined;
79
+ /**
80
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
81
+ *
82
+ * Find the `schema_id` from either:
83
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
84
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
85
+ *
86
+ * Find the `table_id` from either:
87
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
88
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
89
+ */
90
+ objectId?: string | undefined;
91
+ /** Unique id of the refresh operation. */
92
+ refreshId?: bigint | undefined;
116
93
  }
117
94
  /** Response to cancelling a refresh. */
118
- export interface CancelRefreshResponse {
119
- /** The refresh to cancel. */
120
- refresh?: Refresh | undefined;
95
+ interface CancelRefreshResponse {
96
+ /** The refresh to cancel. */
97
+ refresh?: Refresh | undefined;
121
98
  }
122
99
  /** Request to create a Monitor. */
123
- export interface CreateMonitorRequest {
124
- /** The monitor to create. */
125
- monitor?: Monitor | undefined;
100
+ interface CreateMonitorRequest {
101
+ /** The monitor to create. */
102
+ monitor?: Monitor | undefined;
126
103
  }
127
104
  /** Request to create a refresh. */
128
- export interface CreateRefreshRequest {
129
- /** The refresh to create */
130
- refresh?: Refresh | undefined;
105
+ interface CreateRefreshRequest {
106
+ /** The refresh to create */
107
+ refresh?: Refresh | undefined;
131
108
  }
132
109
  /** The data quality monitoring workflow cron schedule. */
133
- export interface CronSchedule {
134
- /** The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html). */
135
- quartzCronExpression?: string | undefined;
136
- /**
137
- * A Java timezone id. The schedule for a job will be resolved with respect to this timezone.
138
- * See `Java TimeZone <http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html>`_ for details.
139
- * The timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression.
140
- */
141
- timezoneId?: string | undefined;
142
- /** Read only field that indicates whether the schedule is paused or not. */
143
- pauseStatus?: CronSchedulePauseStatus | undefined;
110
+ interface CronSchedule {
111
+ /** The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html). */
112
+ quartzCronExpression?: string | undefined;
113
+ /**
114
+ * A Java timezone id. The schedule for a job will be resolved with respect to this timezone.
115
+ * See `Java TimeZone <http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html>`_ for details.
116
+ * The timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression.
117
+ */
118
+ timezoneId?: string | undefined;
119
+ /** Read only field that indicates whether the schedule is paused or not. */
120
+ pauseStatus?: CronSchedulePauseStatus | undefined;
144
121
  }
145
122
  /** Data Profiling Configurations. */
146
- export interface DataProfilingConfig {
147
- /** ID of the schema where output tables are created. */
148
- outputSchemaId?: string | undefined;
149
- /**
150
- * Field for specifying the absolute path to a custom directory to store data-monitoring
151
- * assets. Normally prepopulated to a default user location via UI and Python APIs.
152
- */
153
- assetsDir?: string | undefined;
154
- /** (--[Create:REQ Update:REQ]--) Analysis config which is used to determine analysis logic. */
155
- analysisConfig?: {
156
- $case: 'inferenceLog';
157
- /** `Analysis Configuration` for monitoring inference log tables. */
158
- inferenceLog: InferenceLogConfig;
159
- } | {
160
- $case: 'timeSeries';
161
- /** `Analysis Configuration` for monitoring time series tables. */
162
- timeSeries: TimeSeriesConfig;
163
- } | {
164
- $case: 'snapshot';
165
- /** `Analysis Configuration` for monitoring snapshot tables. */
166
- snapshot: SnapshotConfig;
167
- } | undefined;
168
- /**
169
- * List of column expressions to slice data with for targeted analysis. The data is grouped by
170
- * each expression independently, resulting in a separate slice for each predicate and its
171
- * complements. For example `slicing_exprs=[“col_1”, “col_2 > 10”]` will generate the following
172
- * slices: two slices for `col_2 > 10` (True and False), and one slice per unique value in
173
- * `col1`. For high-cardinality columns, only the top 100 unique values by frequency will
174
- * generate slices.
175
- */
176
- slicingExprs?: string[] | undefined;
177
- /** Custom metrics. */
178
- customMetrics?: DataProfilingCustomMetric[] | undefined;
179
- /**
180
- * Baseline table name.
181
- * Baseline data is used to compute drift from the data in the monitored `table_name`.
182
- * The baseline table and the monitored table shall have the same schema.
183
- */
184
- baselineTableName?: string | undefined;
185
- /** The cron schedule. */
186
- schedule?: CronSchedule | undefined;
187
- /** Field for specifying notification settings. */
188
- notificationSettings?: NotificationSettings | undefined;
189
- /** Whether to skip creating a default dashboard summarizing data quality metrics. */
190
- skipBuiltinDashboard?: boolean | undefined;
191
- /**
192
- * Optional argument to specify the warehouse for dashboard creation. If not specified, the first running
193
- * warehouse will be used.
194
- */
195
- warehouseId?: string | undefined;
196
- /** Unity Catalog table to monitor. Format: `catalog.schema.table_name` */
197
- monitoredTableName?: string | undefined;
198
- /** The data profiling monitor status. */
199
- status?: DataProfilingStatus | undefined;
200
- /** The latest error message for a monitor failure. */
201
- latestMonitorFailureMessage?: string | undefined;
202
- /** Table that stores profile metrics data. Format: `catalog.schema.table_name`. */
203
- profileMetricsTableName?: string | undefined;
204
- /** Table that stores drift metrics data. Format: `catalog.schema.table_name`. */
205
- driftMetricsTableName?: string | undefined;
206
- /**
207
- * Id of dashboard that visualizes the computed metrics.
208
- * This can be empty if the monitor is in PENDING state.
209
- */
210
- dashboardId?: string | undefined;
211
- /**
212
- * Represents the current monitor configuration version in use. The version will be represented in a
213
- * numeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted
214
- * monitor_version numbers.
215
- */
216
- monitorVersion?: bigint | undefined;
217
- /** The warehouse for dashboard creation */
218
- effectiveWarehouseId?: string | undefined;
123
+ interface DataProfilingConfig {
124
+ /** ID of the schema where output tables are created. */
125
+ outputSchemaId?: string | undefined;
126
+ /**
127
+ * Field for specifying the absolute path to a custom directory to store data-monitoring
128
+ * assets. Normally prepopulated to a default user location via UI and Python APIs.
129
+ */
130
+ assetsDir?: string | undefined;
131
+ /** (--[Create:REQ Update:REQ]--) Analysis config which is used to determine analysis logic. */
132
+ analysisConfig?: {
133
+ $case: 'inferenceLog'; /** `Analysis Configuration` for monitoring inference log tables. */
134
+ inferenceLog: InferenceLogConfig;
135
+ } | {
136
+ $case: 'timeSeries'; /** `Analysis Configuration` for monitoring time series tables. */
137
+ timeSeries: TimeSeriesConfig;
138
+ } | {
139
+ $case: 'snapshot'; /** `Analysis Configuration` for monitoring snapshot tables. */
140
+ snapshot: SnapshotConfig;
141
+ } | undefined;
142
+ /**
143
+ * List of column expressions to slice data with for targeted analysis. The data is grouped by
144
+ * each expression independently, resulting in a separate slice for each predicate and its
145
+ * complements. For example `slicing_exprs=[“col_1”, “col_2 > 10”]` will generate the following
146
+ * slices: two slices for `col_2 > 10` (True and False), and one slice per unique value in
147
+ * `col1`. For high-cardinality columns, only the top 100 unique values by frequency will
148
+ * generate slices.
149
+ */
150
+ slicingExprs?: string[] | undefined;
151
+ /** Custom metrics. */
152
+ customMetrics?: DataProfilingCustomMetric[] | undefined;
153
+ /**
154
+ * Baseline table name.
155
+ * Baseline data is used to compute drift from the data in the monitored `table_name`.
156
+ * The baseline table and the monitored table shall have the same schema.
157
+ */
158
+ baselineTableName?: string | undefined;
159
+ /** The cron schedule. */
160
+ schedule?: CronSchedule | undefined;
161
+ /** Field for specifying notification settings. */
162
+ notificationSettings?: NotificationSettings | undefined;
163
+ /** Whether to skip creating a default dashboard summarizing data quality metrics. */
164
+ skipBuiltinDashboard?: boolean | undefined;
165
+ /**
166
+ * Optional argument to specify the warehouse for dashboard creation. If not specified, the first running
167
+ * warehouse will be used.
168
+ */
169
+ warehouseId?: string | undefined;
170
+ /** Unity Catalog table to monitor. Format: `catalog.schema.table_name` */
171
+ monitoredTableName?: string | undefined;
172
+ /** The data profiling monitor status. */
173
+ status?: DataProfilingStatus | undefined;
174
+ /** The latest error message for a monitor failure. */
175
+ latestMonitorFailureMessage?: string | undefined;
176
+ /** Table that stores profile metrics data. Format: `catalog.schema.table_name`. */
177
+ profileMetricsTableName?: string | undefined;
178
+ /** Table that stores drift metrics data. Format: `catalog.schema.table_name`. */
179
+ driftMetricsTableName?: string | undefined;
180
+ /**
181
+ * Id of dashboard that visualizes the computed metrics.
182
+ * This can be empty if the monitor is in PENDING state.
183
+ */
184
+ dashboardId?: string | undefined;
185
+ /**
186
+ * Represents the current monitor configuration version in use. The version will be represented in a
187
+ * numeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted
188
+ * monitor_version numbers.
189
+ */
190
+ monitorVersion?: bigint | undefined;
191
+ /** The warehouse for dashboard creation */
192
+ effectiveWarehouseId?: string | undefined;
219
193
  }
220
194
  /** Custom metric definition. */
221
- export interface DataProfilingCustomMetric {
222
- /** Name of the metric in the output tables. */
223
- name?: string | undefined;
224
- /** Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition). */
225
- definition?: string | undefined;
226
- /**
227
- * A list of column names in the input table the metric should be computed for.
228
- * Can use ``":table"`` to indicate that the metric needs information from multiple columns.
229
- */
230
- inputColumns?: string[] | undefined;
231
- /** The output type of the custom metric. */
232
- outputDataType?: string | undefined;
233
- /** The type of the custom metric. */
234
- type?: DataProfilingCustomMetricType | undefined;
195
+ interface DataProfilingCustomMetric {
196
+ /** Name of the metric in the output tables. */
197
+ name?: string | undefined;
198
+ /** Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition). */
199
+ definition?: string | undefined;
200
+ /**
201
+ * A list of column names in the input table the metric should be computed for.
202
+ * Can use ``":table"`` to indicate that the metric needs information from multiple columns.
203
+ */
204
+ inputColumns?: string[] | undefined;
205
+ /** The output type of the custom metric. */
206
+ outputDataType?: string | undefined;
207
+ /** The type of the custom metric. */
208
+ type?: DataProfilingCustomMetricType | undefined;
235
209
  }
236
210
  /** Request to delete a Monitor. */
237
- export interface DeleteMonitorRequest {
238
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
239
- objectType?: string | undefined;
240
- /**
241
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
242
- *
243
- * Find the `schema_id` from either:
244
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
245
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
246
- *
247
- * Find the `table_id` from either:
248
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
249
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
250
- */
251
- objectId?: string | undefined;
211
+ interface DeleteMonitorRequest {
212
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
213
+ objectType?: string | undefined;
214
+ /**
215
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
216
+ *
217
+ * Find the `schema_id` from either:
218
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
219
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
220
+ *
221
+ * Find the `table_id` from either:
222
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
223
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
224
+ */
225
+ objectId?: string | undefined;
252
226
  }
253
227
  /** Request to delete a ronitor. */
254
- export interface DeleteRefreshRequest {
255
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
256
- objectType?: string | undefined;
257
- /**
258
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
259
- *
260
- * Find the `schema_id` from either:
261
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
262
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
263
- *
264
- * Find the `table_id` from either:
265
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
266
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
267
- */
268
- objectId?: string | undefined;
269
- /** Unique id of the refresh operation. */
270
- refreshId?: bigint | undefined;
228
+ interface DeleteRefreshRequest {
229
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
230
+ objectType?: string | undefined;
231
+ /**
232
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
233
+ *
234
+ * Find the `schema_id` from either:
235
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
236
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
237
+ *
238
+ * Find the `table_id` from either:
239
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
240
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
241
+ */
242
+ objectId?: string | undefined;
243
+ /** Unique id of the refresh operation. */
244
+ refreshId?: bigint | undefined;
271
245
  }
272
246
  /** Request to get a Monitor. */
273
- export interface GetMonitorRequest {
274
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
275
- objectType?: string | undefined;
276
- /**
277
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
278
- *
279
- * Find the `schema_id` from either:
280
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
281
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
282
- *
283
- * Find the `table_id` from either:
284
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
285
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
286
- */
287
- objectId?: string | undefined;
247
+ interface GetMonitorRequest {
248
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
249
+ objectType?: string | undefined;
250
+ /**
251
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
252
+ *
253
+ * Find the `schema_id` from either:
254
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
255
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
256
+ *
257
+ * Find the `table_id` from either:
258
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
259
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
260
+ */
261
+ objectId?: string | undefined;
288
262
  }
289
263
  /** Request to get a refresh. */
290
- export interface GetRefreshRequest {
291
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
292
- objectType?: string | undefined;
293
- /**
294
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
295
- *
296
- * Find the `schema_id` from either:
297
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
298
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
299
- *
300
- * Find the `table_id` from either:
301
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
302
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
303
- */
304
- objectId?: string | undefined;
305
- /** Unique id of the refresh operation. */
306
- refreshId?: bigint | undefined;
264
+ interface GetRefreshRequest {
265
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
266
+ objectType?: string | undefined;
267
+ /**
268
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
269
+ *
270
+ * Find the `schema_id` from either:
271
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
272
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
273
+ *
274
+ * Find the `table_id` from either:
275
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
276
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
277
+ */
278
+ objectId?: string | undefined;
279
+ /** Unique id of the refresh operation. */
280
+ refreshId?: bigint | undefined;
307
281
  }
308
282
  /** Inference log configuration. */
309
- export interface InferenceLogConfig {
310
- /** Problem type the model aims to solve. */
311
- problemType?: InferenceProblemType | undefined;
312
- /** Column for the timestamp. */
313
- timestampColumn?: string | undefined;
314
- /** List of granularities to use when aggregating data into time windows based on their timestamp. */
315
- granularities?: AggregationGranularity[] | undefined;
316
- /** Column for the prediction. */
317
- predictionColumn?: string | undefined;
318
- /** Column for the label. */
319
- labelColumn?: string | undefined;
320
- /** Column for the model identifier. */
321
- modelIdColumn?: string | undefined;
283
+ interface InferenceLogConfig {
284
+ /** Problem type the model aims to solve. */
285
+ problemType?: InferenceProblemType | undefined;
286
+ /** Column for the timestamp. */
287
+ timestampColumn?: string | undefined;
288
+ /** List of granularities to use when aggregating data into time windows based on their timestamp. */
289
+ granularities?: AggregationGranularity[] | undefined;
290
+ /** Column for the prediction. */
291
+ predictionColumn?: string | undefined;
292
+ /** Column for the label. */
293
+ labelColumn?: string | undefined;
294
+ /** Column for the model identifier. */
295
+ modelIdColumn?: string | undefined;
322
296
  }
323
297
  /** Request to list Monitors. */
324
- export interface ListMonitorRequest {
325
- pageToken?: string | undefined;
326
- pageSize?: number | undefined;
298
+ interface ListMonitorRequest {
299
+ pageToken?: string | undefined;
300
+ pageSize?: number | undefined;
327
301
  }
328
302
  /** Response for listing Monitors. */
329
- export interface ListMonitorResponse {
330
- monitors?: Monitor[] | undefined;
331
- nextPageToken?: string | undefined;
303
+ interface ListMonitorResponse {
304
+ monitors?: Monitor[] | undefined;
305
+ nextPageToken?: string | undefined;
332
306
  }
333
307
  /** Request to list refreshes. */
334
- export interface ListRefreshRequest {
335
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
336
- objectType?: string | undefined;
337
- /**
338
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
339
- *
340
- * Find the `schema_id` from either:
341
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
342
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
343
- *
344
- * Find the `table_id` from either:
345
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
346
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
347
- */
348
- objectId?: string | undefined;
349
- pageToken?: string | undefined;
350
- pageSize?: number | undefined;
308
+ interface ListRefreshRequest {
309
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
310
+ objectType?: string | undefined;
311
+ /**
312
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
313
+ *
314
+ * Find the `schema_id` from either:
315
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
316
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
317
+ *
318
+ * Find the `table_id` from either:
319
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
320
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
321
+ */
322
+ objectId?: string | undefined;
323
+ pageToken?: string | undefined;
324
+ pageSize?: number | undefined;
351
325
  }
352
326
  /** Response for listing refreshes. */
353
- export interface ListRefreshResponse {
354
- refreshes?: Refresh[] | undefined;
355
- nextPageToken?: string | undefined;
327
+ interface ListRefreshResponse {
328
+ refreshes?: Refresh[] | undefined;
329
+ nextPageToken?: string | undefined;
356
330
  }
357
331
  /** Monitor for the data quality of unity catalog entities such as schema or table. */
358
- export interface Monitor {
359
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
360
- objectType?: string | undefined;
361
- /**
362
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
363
- *
364
- * Find the `schema_id` from either:
365
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
366
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
367
- *
368
- * Find the `table_id` from either:
369
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
370
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
371
- */
372
- objectId?: string | undefined;
373
- /** Anomaly Detection Configuration, applicable to `schema` object types. */
374
- anomalyDetectionConfig?: AnomalyDetectionConfig | undefined;
375
- /**
376
- * Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`
377
- * must be present.
378
- */
379
- dataProfilingConfig?: DataProfilingConfig | undefined;
332
+ interface Monitor {
333
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
334
+ objectType?: string | undefined;
335
+ /**
336
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
337
+ *
338
+ * Find the `schema_id` from either:
339
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
340
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
341
+ *
342
+ * Find the `table_id` from either:
343
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
344
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
345
+ */
346
+ objectId?: string | undefined;
347
+ /** Anomaly Detection Configuration, applicable to `schema` object types. */
348
+ anomalyDetectionConfig?: AnomalyDetectionConfig | undefined;
349
+ /**
350
+ * Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`
351
+ * must be present.
352
+ */
353
+ dataProfilingConfig?: DataProfilingConfig | undefined;
380
354
  }
381
355
  /** Destination of the data quality monitoring notification. */
382
- export interface NotificationDestination {
383
- /** The list of email addresses to send the notification to. A maximum of 5 email addresses is supported. */
384
- emailAddresses?: string[] | undefined;
356
+ interface NotificationDestination {
357
+ /** The list of email addresses to send the notification to. A maximum of 5 email addresses is supported. */
358
+ emailAddresses?: string[] | undefined;
385
359
  }
386
360
  /** Settings for sending notifications on the data quality monitoring. */
387
- export interface NotificationSettings {
388
- /** Destinations to send notifications on failure/timeout. */
389
- onFailure?: NotificationDestination | undefined;
361
+ interface NotificationSettings {
362
+ /** Destinations to send notifications on failure/timeout. */
363
+ onFailure?: NotificationDestination | undefined;
390
364
  }
391
365
  /** The Refresh object gives information on a refresh of the data quality monitoring pipeline. */
392
- export interface Refresh {
393
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
394
- objectType?: string | undefined;
395
- /**
396
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
397
- *
398
- * Find the `schema_id` from either:
399
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
400
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
401
- *
402
- * Find the `table_id` from either:
403
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
404
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
405
- */
406
- objectId?: string | undefined;
407
- /** Unique id of the refresh operation. */
408
- refreshId?: bigint | undefined;
409
- /** The current state of the refresh. */
410
- state?: RefreshState | undefined;
411
- /** An optional message to give insight into the current state of the refresh (e.g. FAILURE messages). */
412
- message?: string | undefined;
413
- /** Time when the refresh started (milliseconds since 1/1/1970 UTC). */
414
- startTimeMs?: bigint | undefined;
415
- /** Time when the refresh ended (milliseconds since 1/1/1970 UTC). */
416
- endTimeMs?: bigint | undefined;
417
- /** What triggered the refresh. */
418
- trigger?: RefreshTrigger | undefined;
366
+ interface Refresh {
367
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
368
+ objectType?: string | undefined;
369
+ /**
370
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
371
+ *
372
+ * Find the `schema_id` from either:
373
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
374
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
375
+ *
376
+ * Find the `table_id` from either:
377
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
378
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
379
+ */
380
+ objectId?: string | undefined;
381
+ /** Unique id of the refresh operation. */
382
+ refreshId?: bigint | undefined;
383
+ /** The current state of the refresh. */
384
+ state?: RefreshState | undefined;
385
+ /** An optional message to give insight into the current state of the refresh (e.g. FAILURE messages). */
386
+ message?: string | undefined;
387
+ /** Time when the refresh started (milliseconds since 1/1/1970 UTC). */
388
+ startTimeMs?: bigint | undefined;
389
+ /** Time when the refresh ended (milliseconds since 1/1/1970 UTC). */
390
+ endTimeMs?: bigint | undefined;
391
+ /** What triggered the refresh. */
392
+ trigger?: RefreshTrigger | undefined;
419
393
  }
420
394
  /** Snapshot analysis configuration. */
421
- export interface SnapshotConfig {
422
- }
395
+ interface SnapshotConfig {}
423
396
  /** Time series analysis configuration. */
424
- export interface TimeSeriesConfig {
425
- /** Column for the timestamp. */
426
- timestampColumn?: string | undefined;
427
- /** List of granularities to use when aggregating data into time windows based on their timestamp. */
428
- granularities?: AggregationGranularity[] | undefined;
397
+ interface TimeSeriesConfig {
398
+ /** Column for the timestamp. */
399
+ timestampColumn?: string | undefined;
400
+ /** List of granularities to use when aggregating data into time windows based on their timestamp. */
401
+ granularities?: AggregationGranularity[] | undefined;
429
402
  }
430
403
  /** Request to update a Monitor. */
431
- export interface UpdateMonitorRequest {
432
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
433
- objectType?: string | undefined;
434
- /**
435
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
436
- *
437
- * Find the `schema_id` from either:
438
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
439
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
440
- *
441
- * Find the `table_id` from either:
442
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
443
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
444
- */
445
- objectId?: string | undefined;
446
- /** The monitor to update. */
447
- monitor?: Monitor | undefined;
448
- /**
449
- * The field mask to specify which fields to update as a comma-separated list.
450
- * Example value: `data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression`
451
- */
452
- updateMask?: FieldMask<Monitor> | undefined;
404
+ interface UpdateMonitorRequest {
405
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
406
+ objectType?: string | undefined;
407
+ /**
408
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
409
+ *
410
+ * Find the `schema_id` from either:
411
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
412
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
413
+ *
414
+ * Find the `table_id` from either:
415
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
416
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
417
+ */
418
+ objectId?: string | undefined;
419
+ /** The monitor to update. */
420
+ monitor?: Monitor | undefined;
421
+ /**
422
+ * The field mask to specify which fields to update as a comma-separated list.
423
+ * Example value: `data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression`
424
+ */
425
+ updateMask?: FieldMask<Monitor> | undefined;
453
426
  }
454
427
  /** Request to update a refresh. */
455
- export interface UpdateRefreshRequest {
456
- /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
457
- objectType?: string | undefined;
458
- /**
459
- * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
460
- *
461
- * Find the `schema_id` from either:
462
- * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
463
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
464
- *
465
- * Find the `table_id` from either:
466
- * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
467
- * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
468
- */
469
- objectId?: string | undefined;
470
- /** Unique id of the refresh operation. */
471
- refreshId?: bigint | undefined;
472
- /** The refresh to update. */
473
- refresh?: Refresh | undefined;
474
- /** The field mask to specify which fields to update. */
475
- updateMask?: FieldMask<Refresh> | undefined;
428
+ interface UpdateRefreshRequest {
429
+ /** The type of the monitored object. Can be one of the following: `schema` or `table`. */
430
+ objectType?: string | undefined;
431
+ /**
432
+ * The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.
433
+ *
434
+ * Find the `schema_id` from either:
435
+ * 1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.
436
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `schema` > go to the `Details` tab > the `Schema ID` field.
437
+ *
438
+ * Find the `table_id` from either:
439
+ * 1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.
440
+ * 2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) > select the `table` > go to the `Details` tab > the `Table ID` field.
441
+ */
442
+ objectId?: string | undefined;
443
+ /** Unique id of the refresh operation. */
444
+ refreshId?: bigint | undefined;
445
+ /** The refresh to update. */
446
+ refresh?: Refresh | undefined;
447
+ /** The field mask to specify which fields to update. */
448
+ updateMask?: FieldMask<Refresh> | undefined;
476
449
  }
477
- export declare const unmarshalAnomalyDetectionConfigSchema: z.ZodType<AnomalyDetectionConfig>;
478
- export declare const unmarshalCancelRefreshResponseSchema: z.ZodType<CancelRefreshResponse>;
479
- export declare const unmarshalCronScheduleSchema: z.ZodType<CronSchedule>;
480
- export declare const unmarshalDataProfilingConfigSchema: z.ZodType<DataProfilingConfig>;
481
- export declare const unmarshalDataProfilingCustomMetricSchema: z.ZodType<DataProfilingCustomMetric>;
482
- export declare const unmarshalInferenceLogConfigSchema: z.ZodType<InferenceLogConfig>;
483
- export declare const unmarshalListMonitorResponseSchema: z.ZodType<ListMonitorResponse>;
484
- export declare const unmarshalListRefreshResponseSchema: z.ZodType<ListRefreshResponse>;
485
- export declare const unmarshalMonitorSchema: z.ZodType<Monitor>;
486
- export declare const unmarshalNotificationDestinationSchema: z.ZodType<NotificationDestination>;
487
- export declare const unmarshalNotificationSettingsSchema: z.ZodType<NotificationSettings>;
488
- export declare const unmarshalRefreshSchema: z.ZodType<Refresh>;
489
- export declare const unmarshalSnapshotConfigSchema: z.ZodType<SnapshotConfig>;
490
- export declare const unmarshalTimeSeriesConfigSchema: z.ZodType<TimeSeriesConfig>;
491
- export declare const marshalAnomalyDetectionConfigSchema: z.ZodType;
492
- export declare const marshalCancelRefreshRequestSchema: z.ZodType;
493
- export declare const marshalCronScheduleSchema: z.ZodType;
494
- export declare const marshalDataProfilingConfigSchema: z.ZodType;
495
- export declare const marshalDataProfilingCustomMetricSchema: z.ZodType;
496
- export declare const marshalInferenceLogConfigSchema: z.ZodType;
497
- export declare const marshalMonitorSchema: z.ZodType;
498
- export declare const marshalNotificationDestinationSchema: z.ZodType;
499
- export declare const marshalNotificationSettingsSchema: z.ZodType;
500
- export declare const marshalRefreshSchema: z.ZodType;
501
- export declare const marshalSnapshotConfigSchema: z.ZodType;
502
- export declare const marshalTimeSeriesConfigSchema: z.ZodType;
503
- export declare function monitorFieldMask(...paths: string[]): FieldMask<Monitor>;
504
- export declare function refreshFieldMask(...paths: string[]): FieldMask<Refresh>;
450
+ declare const unmarshalAnomalyDetectionConfigSchema: z.ZodType<AnomalyDetectionConfig>;
451
+ declare const unmarshalCancelRefreshResponseSchema: z.ZodType<CancelRefreshResponse>;
452
+ declare const unmarshalCronScheduleSchema: z.ZodType<CronSchedule>;
453
+ declare const unmarshalDataProfilingConfigSchema: z.ZodType<DataProfilingConfig>;
454
+ declare const unmarshalDataProfilingCustomMetricSchema: z.ZodType<DataProfilingCustomMetric>;
455
+ declare const unmarshalInferenceLogConfigSchema: z.ZodType<InferenceLogConfig>;
456
+ declare const unmarshalListMonitorResponseSchema: z.ZodType<ListMonitorResponse>;
457
+ declare const unmarshalListRefreshResponseSchema: z.ZodType<ListRefreshResponse>;
458
+ declare const unmarshalMonitorSchema: z.ZodType<Monitor>;
459
+ declare const unmarshalNotificationDestinationSchema: z.ZodType<NotificationDestination>;
460
+ declare const unmarshalNotificationSettingsSchema: z.ZodType<NotificationSettings>;
461
+ declare const unmarshalRefreshSchema: z.ZodType<Refresh>;
462
+ declare const unmarshalSnapshotConfigSchema: z.ZodType<SnapshotConfig>;
463
+ declare const unmarshalTimeSeriesConfigSchema: z.ZodType<TimeSeriesConfig>;
464
+ declare const marshalAnomalyDetectionConfigSchema: z.ZodType;
465
+ declare const marshalCancelRefreshRequestSchema: z.ZodType;
466
+ declare const marshalCronScheduleSchema: z.ZodType;
467
+ declare const marshalDataProfilingConfigSchema: z.ZodType;
468
+ declare const marshalDataProfilingCustomMetricSchema: z.ZodType;
469
+ declare const marshalInferenceLogConfigSchema: z.ZodType;
470
+ declare const marshalMonitorSchema: z.ZodType;
471
+ declare const marshalNotificationDestinationSchema: z.ZodType;
472
+ declare const marshalNotificationSettingsSchema: z.ZodType;
473
+ declare const marshalRefreshSchema: z.ZodType;
474
+ declare const marshalSnapshotConfigSchema: z.ZodType;
475
+ declare const marshalTimeSeriesConfigSchema: z.ZodType;
476
+ declare function monitorFieldMask(...paths: string[]): FieldMask<Monitor>;
477
+ declare function refreshFieldMask(...paths: string[]): FieldMask<Refresh>;
478
+ //#endregion
479
+ export { AggregationGranularity, AnomalyDetectionConfig, CancelRefreshRequest, CancelRefreshResponse, CreateMonitorRequest, CreateRefreshRequest, CronSchedule, CronSchedulePauseStatus, DataProfilingConfig, DataProfilingCustomMetric, DataProfilingCustomMetricType, DataProfilingStatus, DeleteMonitorRequest, DeleteRefreshRequest, GetMonitorRequest, GetRefreshRequest, InferenceLogConfig, InferenceProblemType, ListMonitorRequest, ListMonitorResponse, ListRefreshRequest, ListRefreshResponse, Monitor, NotificationDestination, NotificationSettings, Refresh, RefreshState, RefreshTrigger, SnapshotConfig, TimeSeriesConfig, UpdateMonitorRequest, UpdateRefreshRequest, marshalAnomalyDetectionConfigSchema, marshalCancelRefreshRequestSchema, marshalCronScheduleSchema, marshalDataProfilingConfigSchema, marshalDataProfilingCustomMetricSchema, marshalInferenceLogConfigSchema, marshalMonitorSchema, marshalNotificationDestinationSchema, marshalNotificationSettingsSchema, marshalRefreshSchema, marshalSnapshotConfigSchema, marshalTimeSeriesConfigSchema, monitorFieldMask, refreshFieldMask, unmarshalAnomalyDetectionConfigSchema, unmarshalCancelRefreshResponseSchema, unmarshalCronScheduleSchema, unmarshalDataProfilingConfigSchema, unmarshalDataProfilingCustomMetricSchema, unmarshalInferenceLogConfigSchema, unmarshalListMonitorResponseSchema, unmarshalListRefreshResponseSchema, unmarshalMonitorSchema, unmarshalNotificationDestinationSchema, unmarshalNotificationSettingsSchema, unmarshalRefreshSchema, unmarshalSnapshotConfigSchema, unmarshalTimeSeriesConfigSchema };
505
480
  //# sourceMappingURL=model.d.ts.map