dataquality

package
v0.95.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 17, 2025 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Overview

Manage the data quality of Unity Catalog objects (currently support `schema` and `table`)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AggregationGranularity

type AggregationGranularity string

The granularity for aggregating data into time windows based on their timestamp.

const AggregationGranularityAggregationGranularity1Day AggregationGranularity = `AGGREGATION_GRANULARITY_1_DAY`
const AggregationGranularityAggregationGranularity1Hour AggregationGranularity = `AGGREGATION_GRANULARITY_1_HOUR`
const AggregationGranularityAggregationGranularity1Month AggregationGranularity = `AGGREGATION_GRANULARITY_1_MONTH`
const AggregationGranularityAggregationGranularity1Week AggregationGranularity = `AGGREGATION_GRANULARITY_1_WEEK`
const AggregationGranularityAggregationGranularity1Year AggregationGranularity = `AGGREGATION_GRANULARITY_1_YEAR`
const AggregationGranularityAggregationGranularity2Weeks AggregationGranularity = `AGGREGATION_GRANULARITY_2_WEEKS`
const AggregationGranularityAggregationGranularity30Minutes AggregationGranularity = `AGGREGATION_GRANULARITY_30_MINUTES`
const AggregationGranularityAggregationGranularity3Weeks AggregationGranularity = `AGGREGATION_GRANULARITY_3_WEEKS`
const AggregationGranularityAggregationGranularity4Weeks AggregationGranularity = `AGGREGATION_GRANULARITY_4_WEEKS`
const AggregationGranularityAggregationGranularity5Minutes AggregationGranularity = `AGGREGATION_GRANULARITY_5_MINUTES`

func (*AggregationGranularity) Set

Set raw string value and validate it against allowed values

func (*AggregationGranularity) String

func (f *AggregationGranularity) String() string

String representation for fmt.Print

func (*AggregationGranularity) Type

func (f *AggregationGranularity) Type() string

Type always returns AggregationGranularity to satisfy [pflag.Value] interface

func (*AggregationGranularity) Values

Values returns all possible values for AggregationGranularity.

There is no guarantee on the order of the values in the slice.

type AnomalyDetectionConfig

type AnomalyDetectionConfig struct {
}

Anomaly Detection Configurations.

type CancelRefreshRequest

type CancelRefreshRequest struct {
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: `schema`
	// or `table`.
	ObjectType string `json:"-" url:"-"`
	// Unique id of the refresh operation.
	RefreshId int64 `json:"-" url:"-"`
}

Request to cancel a refresh.

type CancelRefreshResponse

type CancelRefreshResponse struct {
	// The refresh to cancel.
	Refresh *Refresh `json:"refresh,omitempty"`
}

Response to cancelling a refresh.

type CreateMonitorRequest

type CreateMonitorRequest struct {
	// The monitor to create.
	Monitor Monitor `json:"monitor"`
}

type CreateRefreshRequest

type CreateRefreshRequest struct {
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: `schema`or
	// `table`.
	ObjectType string `json:"-" url:"-"`
	// The refresh to create
	Refresh Refresh `json:"refresh"`
}

type CronSchedule

type CronSchedule struct {
	// Read only field that indicates whether the schedule is paused or not.
	PauseStatus CronSchedulePauseStatus `json:"pause_status,omitempty"`
	// The expression that determines when to run the monitor. See [examples].
	//
	// [examples]: https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html
	QuartzCronExpression string `json:"quartz_cron_expression"`
	// A Java timezone id. The schedule for a job will be resolved with respect
	// to this timezone. See `Java TimeZone
	// <http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html>`_ for
	// details. The timezone id (e.g., “America/Los_Angeles“) in which to
	// evaluate the quartz expression.
	TimezoneId string `json:"timezone_id"`
}

The data quality monitoring workflow cron schedule.

type CronSchedulePauseStatus

type CronSchedulePauseStatus string

The data quality monitoring workflow cron schedule pause status.

const CronSchedulePauseStatusCronSchedulePauseStatusPaused CronSchedulePauseStatus = `CRON_SCHEDULE_PAUSE_STATUS_PAUSED`
const CronSchedulePauseStatusCronSchedulePauseStatusUnpaused CronSchedulePauseStatus = `CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED`

func (*CronSchedulePauseStatus) Set

Set raw string value and validate it against allowed values

func (*CronSchedulePauseStatus) String

func (f *CronSchedulePauseStatus) String() string

String representation for fmt.Print

func (*CronSchedulePauseStatus) Type

func (f *CronSchedulePauseStatus) Type() string

Type always returns CronSchedulePauseStatus to satisfy [pflag.Value] interface

func (*CronSchedulePauseStatus) Values

Values returns all possible values for CronSchedulePauseStatus.

There is no guarantee on the order of the values in the slice.

type DataProfilingConfig

type DataProfilingConfig struct {
	// Field for specifying the absolute path to a custom directory to store
	// data-monitoring assets. Normally prepopulated to a default user location
	// via UI and Python APIs.
	AssetsDir string `json:"assets_dir,omitempty"`
	// Baseline table name. Baseline data is used to compute drift from the data
	// in the monitored `table_name`. The baseline table and the monitored table
	// shall have the same schema.
	BaselineTableName string `json:"baseline_table_name,omitempty"`
	// Custom metrics.
	CustomMetrics []DataProfilingCustomMetric `json:"custom_metrics,omitempty"`
	// Id of dashboard that visualizes the computed metrics. This can be empty
	// if the monitor is in PENDING state.
	DashboardId string `json:"dashboard_id,omitempty"`
	// Table that stores drift metrics data. Format:
	// `catalog.schema.table_name`.
	DriftMetricsTableName string `json:"drift_metrics_table_name,omitempty"`
	// The warehouse for dashboard creation
	EffectiveWarehouseId string `json:"effective_warehouse_id,omitempty"`
	// `Analysis Configuration` for monitoring inference log tables.
	InferenceLog *InferenceLogConfig `json:"inference_log,omitempty"`
	// The latest error message for a monitor failure.
	LatestMonitorFailureMessage string `json:"latest_monitor_failure_message,omitempty"`
	// Represents the current monitor configuration version in use. The version
	// will be represented in a numeric fashion (1,2,3...). The field has
	// flexibility to take on negative values, which can indicate corrupted
	// monitor_version numbers.
	MonitorVersion int64 `json:"monitor_version,omitempty"`
	// Unity Catalog table to monitor. Format: `catalog.schema.table_name`
	MonitoredTableName string `json:"monitored_table_name,omitempty"`
	// Field for specifying notification settings.
	NotificationSettings *NotificationSettings `json:"notification_settings,omitempty"`
	// ID of the schema where output tables are created.
	OutputSchemaId string `json:"output_schema_id"`
	// Table that stores profile metrics data. Format:
	// `catalog.schema.table_name`.
	ProfileMetricsTableName string `json:"profile_metrics_table_name,omitempty"`
	// The cron schedule.
	Schedule *CronSchedule `json:"schedule,omitempty"`
	// Whether to skip creating a default dashboard summarizing data quality
	// metrics.
	SkipBuiltinDashboard bool `json:"skip_builtin_dashboard,omitempty"`
	// List of column expressions to slice data with for targeted analysis. The
	// data is grouped by each expression independently, resulting in a separate
	// slice for each predicate and its complements. For example
	// `slicing_exprs=[“col_1”, “col_2 > 10”]` will generate the
	// following slices: two slices for `col_2 > 10` (True and False), and one
	// slice per unique value in `col1`. For high-cardinality columns, only the
	// top 100 unique values by frequency will generate slices.
	SlicingExprs []string `json:"slicing_exprs,omitempty"`
	// `Analysis Configuration` for monitoring snapshot tables.
	Snapshot *SnapshotConfig `json:"snapshot,omitempty"`
	// The data profiling monitor status.
	Status DataProfilingStatus `json:"status,omitempty"`
	// `Analysis Configuration` for monitoring time series tables.
	TimeSeries *TimeSeriesConfig `json:"time_series,omitempty"`
	// Optional argument to specify the warehouse for dashboard creation. If not
	// specified, the first running warehouse will be used.
	WarehouseId string `json:"warehouse_id,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

Data Profiling Configurations.

func (DataProfilingConfig) MarshalJSON

func (s DataProfilingConfig) MarshalJSON() ([]byte, error)

func (*DataProfilingConfig) UnmarshalJSON

func (s *DataProfilingConfig) UnmarshalJSON(b []byte) error

type DataProfilingCustomMetric

type DataProfilingCustomMetric struct {
	// Jinja template for a SQL expression that specifies how to compute the
	// metric. See [create metric definition].
	//
	// [create metric definition]: https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition
	Definition string `json:"definition"`
	// A list of column names in the input table the metric should be computed
	// for. Can use “":table"“ to indicate that the metric needs information
	// from multiple columns.
	InputColumns []string `json:"input_columns"`
	// Name of the metric in the output tables.
	Name string `json:"name"`
	// The output type of the custom metric.
	OutputDataType string `json:"output_data_type"`
	// The type of the custom metric.
	Type DataProfilingCustomMetricType `json:"type"`
}

Custom metric definition.

type DataProfilingCustomMetricType

type DataProfilingCustomMetricType string

The custom metric type.

const DataProfilingCustomMetricTypeDataProfilingCustomMetricTypeAggregate DataProfilingCustomMetricType = `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE`
const DataProfilingCustomMetricTypeDataProfilingCustomMetricTypeDerived DataProfilingCustomMetricType = `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED`
const DataProfilingCustomMetricTypeDataProfilingCustomMetricTypeDrift DataProfilingCustomMetricType = `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT`

func (*DataProfilingCustomMetricType) Set

Set raw string value and validate it against allowed values

func (*DataProfilingCustomMetricType) String

String representation for fmt.Print

func (*DataProfilingCustomMetricType) Type

Type always returns DataProfilingCustomMetricType to satisfy [pflag.Value] interface

func (*DataProfilingCustomMetricType) Values

Values returns all possible values for DataProfilingCustomMetricType.

There is no guarantee on the order of the values in the slice.

type DataProfilingStatus

type DataProfilingStatus string

The status of the data profiling monitor.

const DataProfilingStatusDataProfilingStatusActive DataProfilingStatus = `DATA_PROFILING_STATUS_ACTIVE`
const DataProfilingStatusDataProfilingStatusDeletePending DataProfilingStatus = `DATA_PROFILING_STATUS_DELETE_PENDING`
const DataProfilingStatusDataProfilingStatusError DataProfilingStatus = `DATA_PROFILING_STATUS_ERROR`
const DataProfilingStatusDataProfilingStatusFailed DataProfilingStatus = `DATA_PROFILING_STATUS_FAILED`
const DataProfilingStatusDataProfilingStatusPending DataProfilingStatus = `DATA_PROFILING_STATUS_PENDING`

func (*DataProfilingStatus) Set

func (f *DataProfilingStatus) Set(v string) error

Set raw string value and validate it against allowed values

func (*DataProfilingStatus) String

func (f *DataProfilingStatus) String() string

String representation for fmt.Print

func (*DataProfilingStatus) Type

func (f *DataProfilingStatus) Type() string

Type always returns DataProfilingStatus to satisfy [pflag.Value] interface

func (*DataProfilingStatus) Values

Values returns all possible values for DataProfilingStatus.

There is no guarantee on the order of the values in the slice.

type DataQualityAPI

type DataQualityAPI struct {
	// contains filtered or unexported fields
}

Manage the data quality of Unity Catalog objects (currently support `schema` and `table`)

func NewDataQuality

func NewDataQuality(client *client.DatabricksClient) *DataQualityAPI

func (*DataQualityAPI) CancelRefresh

func (a *DataQualityAPI) CancelRefresh(ctx context.Context, request CancelRefreshRequest) (*CancelRefreshResponse, error)

func (*DataQualityAPI) CreateMonitor

func (a *DataQualityAPI) CreateMonitor(ctx context.Context, request CreateMonitorRequest) (*Monitor, error)

func (*DataQualityAPI) CreateRefresh

func (a *DataQualityAPI) CreateRefresh(ctx context.Context, request CreateRefreshRequest) (*Refresh, error)

func (*DataQualityAPI) DeleteMonitor

func (a *DataQualityAPI) DeleteMonitor(ctx context.Context, request DeleteMonitorRequest) error

func (*DataQualityAPI) DeleteRefresh

func (a *DataQualityAPI) DeleteRefresh(ctx context.Context, request DeleteRefreshRequest) error

func (*DataQualityAPI) GetMonitor

func (a *DataQualityAPI) GetMonitor(ctx context.Context, request GetMonitorRequest) (*Monitor, error)

func (*DataQualityAPI) GetRefresh

func (a *DataQualityAPI) GetRefresh(ctx context.Context, request GetRefreshRequest) (*Refresh, error)

func (*DataQualityAPI) ListMonitor

func (a *DataQualityAPI) ListMonitor(ctx context.Context, request ListMonitorRequest) listing.Iterator[Monitor]

(Unimplemented) List data quality monitors.

func (*DataQualityAPI) ListMonitorAll

func (a *DataQualityAPI) ListMonitorAll(ctx context.Context, request ListMonitorRequest) ([]Monitor, error)

(Unimplemented) List data quality monitors.

func (*DataQualityAPI) ListRefresh

func (a *DataQualityAPI) ListRefresh(ctx context.Context, request ListRefreshRequest) listing.Iterator[Refresh]

List data quality monitor refreshes. The call must be made in the same workspace as where the monitor was created.

For the `table` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.

For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the schema.

func (*DataQualityAPI) ListRefreshAll

func (a *DataQualityAPI) ListRefreshAll(ctx context.Context, request ListRefreshRequest) ([]Refresh, error)

List data quality monitor refreshes. The call must be made in the same workspace as where the monitor was created.

For the `table` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table.

For the `schema` `object_type`, the caller must have either of the following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **USE_SCHEMA** on the schema.

func (*DataQualityAPI) UpdateMonitor

func (a *DataQualityAPI) UpdateMonitor(ctx context.Context, request UpdateMonitorRequest) (*Monitor, error)

func (*DataQualityAPI) UpdateRefresh

func (a *DataQualityAPI) UpdateRefresh(ctx context.Context, request UpdateRefreshRequest) (*Refresh, error)

type DataQualityInterface

type DataQualityInterface interface {

	// Cancels a data quality monitor refresh. Currently only supported for the
	// `table` `object_type`. The call must be made in the same workspace as where
	// the monitor was created.
	//
	// The caller must have either of the following sets of permissions: 1.
	// **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2.
	// **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **MANAGE** on the table.
	CancelRefresh(ctx context.Context, request CancelRefreshRequest) (*CancelRefreshResponse, error)

	// Create a data quality monitor on a Unity Catalog object. The caller must
	// provide either `anomaly_detection_config` for a schema monitor or
	// `data_profiling_config` for a table monitor.
	//
	// For the `table` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent
	// catalog, **USE_SCHEMA** on the table's parent schema, and **SELECT** on the
	// table 2. **USE_CATALOG** on the table's parent catalog, **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema, and **SELECT** on the table. 3.
	// **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the table's
	// parent schema, and **MANAGE** and **SELECT** on the table.
	//
	// Workspace assets, such as the dashboard, will be created in the workspace
	// where this call was made.
	//
	// For the `schema` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent
	// catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE**
	// and **USE_SCHEMA** on the schema.
	CreateMonitor(ctx context.Context, request CreateMonitorRequest) (*Monitor, error)

	// Creates a refresh. Currently only supported for the `table` `object_type`.
	// The call must be made in the same workspace as where the monitor was created.
	//
	// The caller must have either of the following sets of permissions: 1.
	// **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2.
	// **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **MANAGE** on the table.
	CreateRefresh(ctx context.Context, request CreateRefreshRequest) (*Refresh, error)

	// Delete a data quality monitor on Unity Catalog object.
	//
	// For the `table` `object_type`, the caller must have either of the following
	// sets of permissions: **MANAGE** and **USE_CATALOG** on the table's parent
	// catalog. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. **USE_CATALOG** on the table's
	// parent catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE**
	// on the table.
	//
	// Note that the metric tables and dashboard will not be deleted as part of this
	// call; those assets must be manually cleaned up (if desired).
	//
	// For the `schema` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent
	// catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE**
	// and **USE_SCHEMA** on the schema.
	DeleteMonitor(ctx context.Context, request DeleteMonitorRequest) error

	// (Unimplemented) Delete a refresh
	DeleteRefresh(ctx context.Context, request DeleteRefreshRequest) error

	// Read a data quality monitor on a Unity Catalog object.
	//
	// For the `table` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent
	// catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **SELECT** on the table.
	//
	// For the `schema` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent
	// catalog. 2. **USE_CATALOG** on the schema's parent catalog, and
	// **USE_SCHEMA** on the schema.
	//
	// The returned information includes configuration values on the entity and
	// parent entity as well as information on assets created by the monitor. Some
	// information (e.g. dashboard) may be filtered out if the caller is in a
	// different workspace than where the monitor was created.
	GetMonitor(ctx context.Context, request GetMonitorRequest) (*Monitor, error)

	// Get data quality monitor refresh. The call must be made in the same workspace
	// as where the monitor was created.
	//
	// For the `table` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent
	// catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **SELECT** on the table.
	//
	// For the `schema` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent
	// catalog. 2. **USE_CATALOG** on the schema's parent catalog, and
	// **USE_SCHEMA** on the schema.
	GetRefresh(ctx context.Context, request GetRefreshRequest) (*Refresh, error)

	// (Unimplemented) List data quality monitors.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListMonitor(ctx context.Context, request ListMonitorRequest) listing.Iterator[Monitor]

	// (Unimplemented) List data quality monitors.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListMonitorAll(ctx context.Context, request ListMonitorRequest) ([]Monitor, error)

	// List data quality monitor refreshes. The call must be made in the same
	// workspace as where the monitor was created.
	//
	// For the `table` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent
	// catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **SELECT** on the table.
	//
	// For the `schema` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent
	// catalog. 2. **USE_CATALOG** on the schema's parent catalog, and
	// **USE_SCHEMA** on the schema.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListRefresh(ctx context.Context, request ListRefreshRequest) listing.Iterator[Refresh]

	// List data quality monitor refreshes. The call must be made in the same
	// workspace as where the monitor was created.
	//
	// For the `table` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent
	// catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **SELECT** on the table.
	//
	// For the `schema` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent
	// catalog. 2. **USE_CATALOG** on the schema's parent catalog, and
	// **USE_SCHEMA** on the schema.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListRefreshAll(ctx context.Context, request ListRefreshRequest) ([]Refresh, error)

	// Update a data quality monitor on Unity Catalog object.
	//
	// For the `table` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the table's parent
	// catalog. 2. **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **MANAGE** on the table.
	//
	// For the `schema` `object_type`, the caller must have either of the following
	// sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the schema's parent
	// catalog. 2. **USE_CATALOG** on the schema's parent catalog, and **MANAGE**
	// and **USE_SCHEMA** on the schema.
	UpdateMonitor(ctx context.Context, request UpdateMonitorRequest) (*Monitor, error)

	// (Unimplemented) Update a refresh
	UpdateRefresh(ctx context.Context, request UpdateRefreshRequest) (*Refresh, error)
}

type DataQualityService deprecated

type DataQualityService interface {

	// Cancels a data quality monitor refresh. Currently only supported for the
	// `table` `object_type`. The call must be made in the same workspace as
	// where the monitor was created.
	//
	// The caller must have either of the following sets of permissions: 1.
	// **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2.
	// **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **MANAGE** on the table.
	CancelRefresh(ctx context.Context, request CancelRefreshRequest) (*CancelRefreshResponse, error)

	// Create a data quality monitor on a Unity Catalog object. The caller must
	// provide either `anomaly_detection_config` for a schema monitor or
	// `data_profiling_config` for a table monitor.
	//
	// For the `table` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **SELECT** on the table 2. **USE_CATALOG** on the table's parent catalog,
	// **MANAGE** and **USE_SCHEMA** on the table's parent schema, and
	// **SELECT** on the table. 3. **USE_CATALOG** on the table's parent
	// catalog, **USE_SCHEMA** on the table's parent schema, and **MANAGE** and
	// **SELECT** on the table.
	//
	// Workspace assets, such as the dashboard, will be created in the workspace
	// where this call was made.
	//
	// For the `schema` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// schema's parent catalog. 2. **USE_CATALOG** on the schema's parent
	// catalog, and **MANAGE** and **USE_SCHEMA** on the schema.
	CreateMonitor(ctx context.Context, request CreateMonitorRequest) (*Monitor, error)

	// Creates a refresh. Currently only supported for the `table`
	// `object_type`. The call must be made in the same workspace as where the
	// monitor was created.
	//
	// The caller must have either of the following sets of permissions: 1.
	// **MANAGE** and **USE_CATALOG** on the table's parent catalog. 2.
	// **USE_CATALOG** on the table's parent catalog, and **MANAGE** and
	// **USE_SCHEMA** on the table's parent schema. 3. **USE_CATALOG** on the
	// table's parent catalog, **USE_SCHEMA** on the table's parent schema, and
	// **MANAGE** on the table.
	CreateRefresh(ctx context.Context, request CreateRefreshRequest) (*Refresh, error)

	// Delete a data quality monitor on Unity Catalog object.
	//
	// For the `table` `object_type`, the caller must have either of the
	// following sets of permissions: **MANAGE** and **USE_CATALOG** on the
	// table's parent catalog. **USE_CATALOG** on the table's parent catalog,
	// and **MANAGE** and **USE_SCHEMA** on the table's parent schema.
	// **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the
	// table's parent schema, and **MANAGE** on the table.
	//
	// Note that the metric tables and dashboard will not be deleted as part of
	// this call; those assets must be manually cleaned up (if desired).
	//
	// For the `schema` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// schema's parent catalog. 2. **USE_CATALOG** on the schema's parent
	// catalog, and **MANAGE** and **USE_SCHEMA** on the schema.
	DeleteMonitor(ctx context.Context, request DeleteMonitorRequest) error

	// (Unimplemented) Delete a refresh
	DeleteRefresh(ctx context.Context, request DeleteRefreshRequest) error

	// Read a data quality monitor on a Unity Catalog object.
	//
	// For the `table` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog,
	// and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3.
	// **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the
	// table's parent schema, and **SELECT** on the table.
	//
	// For the `schema` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// schema's parent catalog. 2. **USE_CATALOG** on the schema's parent
	// catalog, and **USE_SCHEMA** on the schema.
	//
	// The returned information includes configuration values on the entity and
	// parent entity as well as information on assets created by the monitor.
	// Some information (e.g. dashboard) may be filtered out if the caller is in
	// a different workspace than where the monitor was created.
	GetMonitor(ctx context.Context, request GetMonitorRequest) (*Monitor, error)

	// Get data quality monitor refresh. The call must be made in the same
	// workspace as where the monitor was created.
	//
	// For the `table` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog,
	// and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3.
	// **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the
	// table's parent schema, and **SELECT** on the table.
	//
	// For the `schema` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// schema's parent catalog. 2. **USE_CATALOG** on the schema's parent
	// catalog, and **USE_SCHEMA** on the schema.
	GetRefresh(ctx context.Context, request GetRefreshRequest) (*Refresh, error)

	// (Unimplemented) List data quality monitors.
	ListMonitor(ctx context.Context, request ListMonitorRequest) (*ListMonitorResponse, error)

	// List data quality monitor refreshes. The call must be made in the same
	// workspace as where the monitor was created.
	//
	// For the `table` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog,
	// and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3.
	// **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the
	// table's parent schema, and **SELECT** on the table.
	//
	// For the `schema` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// schema's parent catalog. 2. **USE_CATALOG** on the schema's parent
	// catalog, and **USE_SCHEMA** on the schema.
	ListRefresh(ctx context.Context, request ListRefreshRequest) (*ListRefreshResponse, error)

	// Update a data quality monitor on Unity Catalog object.
	//
	// For the `table` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// table's parent catalog. 2. **USE_CATALOG** on the table's parent catalog,
	// and **MANAGE** and **USE_SCHEMA** on the table's parent schema. 3.
	// **USE_CATALOG** on the table's parent catalog, **USE_SCHEMA** on the
	// table's parent schema, and **MANAGE** on the table.
	//
	// For the `schema` `object_type`, the caller must have either of the
	// following sets of permissions: 1. **MANAGE** and **USE_CATALOG** on the
	// schema's parent catalog. 2. **USE_CATALOG** on the schema's parent
	// catalog, and **MANAGE** and **USE_SCHEMA** on the schema.
	UpdateMonitor(ctx context.Context, request UpdateMonitorRequest) (*Monitor, error)

	// (Unimplemented) Update a refresh
	UpdateRefresh(ctx context.Context, request UpdateRefreshRequest) (*Refresh, error)
}

Manage the data quality of Unity Catalog objects (currently support `schema` and `table`)

Deprecated: Do not use this interface, it will be removed in a future version of the SDK.

type DeleteMonitorRequest

type DeleteMonitorRequest struct {
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: `schema`
	// or `table`.
	ObjectType string `json:"-" url:"-"`
}

type DeleteRefreshRequest

type DeleteRefreshRequest struct {
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: `schema`
	// or `table`.
	ObjectType string `json:"-" url:"-"`
	// Unique id of the refresh operation.
	RefreshId int64 `json:"-" url:"-"`
}

type GetMonitorRequest

type GetMonitorRequest struct {
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: `schema`
	// or `table`.
	ObjectType string `json:"-" url:"-"`
}

type GetRefreshRequest

type GetRefreshRequest struct {
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: `schema`
	// or `table`.
	ObjectType string `json:"-" url:"-"`
	// Unique id of the refresh operation.
	RefreshId int64 `json:"-" url:"-"`
}

type InferenceLogConfig

type InferenceLogConfig struct {
	// List of granularities to use when aggregating data into time windows
	// based on their timestamp.
	Granularities []AggregationGranularity `json:"granularities"`
	// Column for the label.
	LabelColumn string `json:"label_column,omitempty"`
	// Column for the model identifier.
	ModelIdColumn string `json:"model_id_column"`
	// Column for the prediction.
	PredictionColumn string `json:"prediction_column"`
	// Problem type the model aims to solve.
	ProblemType InferenceProblemType `json:"problem_type"`
	// Column for the timestamp.
	TimestampColumn string `json:"timestamp_column"`

	ForceSendFields []string `json:"-" url:"-"`
}

Inference log configuration.

func (InferenceLogConfig) MarshalJSON

func (s InferenceLogConfig) MarshalJSON() ([]byte, error)

func (*InferenceLogConfig) UnmarshalJSON

func (s *InferenceLogConfig) UnmarshalJSON(b []byte) error

type InferenceProblemType

type InferenceProblemType string

Inference problem type the model aims to solve.

const InferenceProblemTypeInferenceProblemTypeClassification InferenceProblemType = `INFERENCE_PROBLEM_TYPE_CLASSIFICATION`
const InferenceProblemTypeInferenceProblemTypeRegression InferenceProblemType = `INFERENCE_PROBLEM_TYPE_REGRESSION`

func (*InferenceProblemType) Set

func (f *InferenceProblemType) Set(v string) error

Set raw string value and validate it against allowed values

func (*InferenceProblemType) String

func (f *InferenceProblemType) String() string

String representation for fmt.Print

func (*InferenceProblemType) Type

func (f *InferenceProblemType) Type() string

Type always returns InferenceProblemType to satisfy [pflag.Value] interface

func (*InferenceProblemType) Values

Values returns all possible values for InferenceProblemType.

There is no guarantee on the order of the values in the slice.

type ListMonitorRequest

type ListMonitorRequest struct {
	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

func (ListMonitorRequest) MarshalJSON

func (s ListMonitorRequest) MarshalJSON() ([]byte, error)

func (*ListMonitorRequest) UnmarshalJSON

func (s *ListMonitorRequest) UnmarshalJSON(b []byte) error

type ListMonitorResponse

type ListMonitorResponse struct {
	Monitors []Monitor `json:"monitors,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

Response for listing Monitors.

func (ListMonitorResponse) MarshalJSON

func (s ListMonitorResponse) MarshalJSON() ([]byte, error)

func (*ListMonitorResponse) UnmarshalJSON

func (s *ListMonitorResponse) UnmarshalJSON(b []byte) error

type ListRefreshRequest

type ListRefreshRequest struct {
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: `schema`
	// or `table`.
	ObjectType string `json:"-" url:"-"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

func (ListRefreshRequest) MarshalJSON

func (s ListRefreshRequest) MarshalJSON() ([]byte, error)

func (*ListRefreshRequest) UnmarshalJSON

func (s *ListRefreshRequest) UnmarshalJSON(b []byte) error

type ListRefreshResponse

type ListRefreshResponse struct {
	NextPageToken string `json:"next_page_token,omitempty"`

	Refreshes []Refresh `json:"refreshes,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

Response for listing refreshes.

func (ListRefreshResponse) MarshalJSON

func (s ListRefreshResponse) MarshalJSON() ([]byte, error)

func (*ListRefreshResponse) UnmarshalJSON

func (s *ListRefreshResponse) UnmarshalJSON(b []byte) error

type Monitor

type Monitor struct {
	// Anomaly Detection Configuration, applicable to `schema` object types.
	AnomalyDetectionConfig *AnomalyDetectionConfig `json:"anomaly_detection_config,omitempty"`
	// Data Profiling Configuration, applicable to `table` object types. Exactly
	// one `Analysis Configuration` must be present.
	DataProfilingConfig *DataProfilingConfig `json:"data_profiling_config,omitempty"`
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"object_id"`
	// The type of the monitored object. Can be one of the following: `schema`
	// or `table`.
	ObjectType string `json:"object_type"`
}

Monitor for the data quality of unity catalog entities such as schema or table.

type NotificationDestination

type NotificationDestination struct {
	// The list of email addresses to send the notification to. A maximum of 5
	// email addresses is supported.
	EmailAddresses []string `json:"email_addresses,omitempty"`
}

Destination of the data quality monitoring notification.

type NotificationSettings

type NotificationSettings struct {
	// Destinations to send notifications on failure/timeout.
	OnFailure *NotificationDestination `json:"on_failure,omitempty"`
}

Settings for sending notifications on the data quality monitoring.

type Refresh

type Refresh struct {
	// Time when the refresh ended (milliseconds since 1/1/1970 UTC).
	EndTimeMs int64 `json:"end_time_ms,omitempty"`
	// An optional message to give insight into the current state of the refresh
	// (e.g. FAILURE messages).
	Message string `json:"message,omitempty"`
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"object_id"`
	// The type of the monitored object. Can be one of the following: `schema`or
	// `table`.
	ObjectType string `json:"object_type"`
	// Unique id of the refresh operation.
	RefreshId int64 `json:"refresh_id,omitempty"`
	// Time when the refresh started (milliseconds since 1/1/1970 UTC).
	StartTimeMs int64 `json:"start_time_ms,omitempty"`
	// The current state of the refresh.
	State RefreshState `json:"state,omitempty"`
	// What triggered the refresh.
	Trigger RefreshTrigger `json:"trigger,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

The Refresh object gives information on a refresh of the data quality monitoring pipeline.

func (Refresh) MarshalJSON

func (s Refresh) MarshalJSON() ([]byte, error)

func (*Refresh) UnmarshalJSON

func (s *Refresh) UnmarshalJSON(b []byte) error

type RefreshState

type RefreshState string

The state of the refresh.

const RefreshStateMonitorRefreshStateCanceled RefreshState = `MONITOR_REFRESH_STATE_CANCELED`
const RefreshStateMonitorRefreshStateFailed RefreshState = `MONITOR_REFRESH_STATE_FAILED`
const RefreshStateMonitorRefreshStatePending RefreshState = `MONITOR_REFRESH_STATE_PENDING`
const RefreshStateMonitorRefreshStateRunning RefreshState = `MONITOR_REFRESH_STATE_RUNNING`
const RefreshStateMonitorRefreshStateSuccess RefreshState = `MONITOR_REFRESH_STATE_SUCCESS`
const RefreshStateMonitorRefreshStateUnknown RefreshState = `MONITOR_REFRESH_STATE_UNKNOWN`

func (*RefreshState) Set

func (f *RefreshState) Set(v string) error

Set raw string value and validate it against allowed values

func (*RefreshState) String

func (f *RefreshState) String() string

String representation for fmt.Print

func (*RefreshState) Type

func (f *RefreshState) Type() string

Type always returns RefreshState to satisfy [pflag.Value] interface

func (*RefreshState) Values

func (f *RefreshState) Values() []RefreshState

Values returns all possible values for RefreshState.

There is no guarantee on the order of the values in the slice.

type RefreshTrigger

type RefreshTrigger string

The trigger of the refresh.

const RefreshTriggerMonitorRefreshTriggerDataChange RefreshTrigger = `MONITOR_REFRESH_TRIGGER_DATA_CHANGE`
const RefreshTriggerMonitorRefreshTriggerManual RefreshTrigger = `MONITOR_REFRESH_TRIGGER_MANUAL`
const RefreshTriggerMonitorRefreshTriggerSchedule RefreshTrigger = `MONITOR_REFRESH_TRIGGER_SCHEDULE`
const RefreshTriggerMonitorRefreshTriggerUnknown RefreshTrigger = `MONITOR_REFRESH_TRIGGER_UNKNOWN`

func (*RefreshTrigger) Set

func (f *RefreshTrigger) Set(v string) error

Set raw string value and validate it against allowed values

func (*RefreshTrigger) String

func (f *RefreshTrigger) String() string

String representation for fmt.Print

func (*RefreshTrigger) Type

func (f *RefreshTrigger) Type() string

Type always returns RefreshTrigger to satisfy [pflag.Value] interface

func (*RefreshTrigger) Values

func (f *RefreshTrigger) Values() []RefreshTrigger

Values returns all possible values for RefreshTrigger.

There is no guarantee on the order of the values in the slice.

type SnapshotConfig

type SnapshotConfig struct {
}

Snapshot analysis configuration.

type TimeSeriesConfig

type TimeSeriesConfig struct {
	// List of granularities to use when aggregating data into time windows
	// based on their timestamp.
	Granularities []AggregationGranularity `json:"granularities"`
	// Column for the timestamp.
	TimestampColumn string `json:"timestamp_column"`
}

Time series analysis configuration.

type UpdateMonitorRequest

type UpdateMonitorRequest struct {
	// The monitor to update.
	Monitor Monitor `json:"monitor"`
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: `schema`
	// or `table`.
	ObjectType string `json:"-" url:"-"`
	// The field mask to specify which fields to update as a comma-separated
	// list. Example value:
	// `data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression`
	UpdateMask string `json:"-" url:"update_mask"`
}

type UpdateRefreshRequest

type UpdateRefreshRequest struct {
	// The UUID of the request object. It is `schema_id` for `schema`, and
	// `table_id` for `table`.
	//
	// Find the `schema_id` from either: 1. The [schema_id] of the `Schemas`
	// resource. 2. In [Catalog Explorer] > select the `schema` > go to the
	// `Details` tab > the `Schema ID` field.
	//
	// Find the `table_id` from either: 1. The [table_id] of the `Tables`
	// resource. 2. In [Catalog Explorer] > select the `table` > go to the
	// `Details` tab > the `Table ID` field.
	//
	// [Catalog Explorer]: https://docs.databricks.com/aws/en/catalog-explorer/
	// [schema_id]: https://docs.databricks.com/api/workspace/schemas/get#schema_id
	// [table_id]: https://docs.databricks.com/api/workspace/tables/get#table_id
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: `schema`
	// or `table`.
	ObjectType string `json:"-" url:"-"`
	// The refresh to update.
	Refresh Refresh `json:"refresh"`
	// Unique id of the refresh operation.
	RefreshId int64 `json:"-" url:"-"`
	// The field mask to specify which fields to update.
	UpdateMask string `json:"-" url:"update_mask"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL