Help us shape the future of Go! Take the 2026 Go Developer Survey

qualitymonitorv2

package
v0.189.0 Latest Latest
Warning

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

Go to latest
Published: Oct 19, 2026 License: Apache-2.0 Imports: 7 Imported by: 2

Documentation

Overview

Deprecated: Please use the Data Quality Monitoring API instead (REST: /api/data-quality/v1/monitors). Manage data quality of UC objects (currently support `schema`).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AnomalyDetectionConfig

type AnomalyDetectionConfig struct {
	// List of fully qualified table names to exclude from anomaly detection.
	ExcludedTableFullNames []string `json:"excluded_table_full_names,omitempty"`
	// Run id of the last run of the workflow
	LastRunId string `json:"last_run_id,omitempty"`
	// The status of the last run of the workflow.
	LatestRunStatus AnomalyDetectionRunStatus `json:"latest_run_status,omitempty"`

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

func (AnomalyDetectionConfig) MarshalJSON

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

func (*AnomalyDetectionConfig) UnmarshalJSON

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

type AnomalyDetectionRunStatus

type AnomalyDetectionRunStatus string

Status of Anomaly Detection Job Run

const AnomalyDetectionRunStatusAnomalyDetectionRunStatusCanceled AnomalyDetectionRunStatus = `ANOMALY_DETECTION_RUN_STATUS_CANCELED`
const AnomalyDetectionRunStatusAnomalyDetectionRunStatusFailed AnomalyDetectionRunStatus = `ANOMALY_DETECTION_RUN_STATUS_FAILED`
const AnomalyDetectionRunStatusAnomalyDetectionRunStatusJobDeleted AnomalyDetectionRunStatus = `ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED`
const AnomalyDetectionRunStatusAnomalyDetectionRunStatusPending AnomalyDetectionRunStatus = `ANOMALY_DETECTION_RUN_STATUS_PENDING`
const AnomalyDetectionRunStatusAnomalyDetectionRunStatusRunning AnomalyDetectionRunStatus = `ANOMALY_DETECTION_RUN_STATUS_RUNNING`
const AnomalyDetectionRunStatusAnomalyDetectionRunStatusSuccess AnomalyDetectionRunStatus = `ANOMALY_DETECTION_RUN_STATUS_SUCCESS`
const AnomalyDetectionRunStatusAnomalyDetectionRunStatusUnknown AnomalyDetectionRunStatus = `ANOMALY_DETECTION_RUN_STATUS_UNKNOWN`
const AnomalyDetectionRunStatusAnomalyDetectionRunStatusWorkspaceMismatchError AnomalyDetectionRunStatus = `ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR`

func (*AnomalyDetectionRunStatus) Set

Set raw string value and validate it against allowed values

func (*AnomalyDetectionRunStatus) String

func (f *AnomalyDetectionRunStatus) String() string

String representation for fmt.Print

func (*AnomalyDetectionRunStatus) Type

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

func (*AnomalyDetectionRunStatus) Values

Values returns all possible values for AnomalyDetectionRunStatus.

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

type CreateQualityMonitorRequest

type CreateQualityMonitorRequest struct {
	QualityMonitor QualityMonitor `json:"quality_monitor"`
}

func (*CreateQualityMonitorRequest) UnmarshalJSON added in v0.73.0

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

type DeleteQualityMonitorRequest

type DeleteQualityMonitorRequest struct {
	// The uuid of the request object. For example, schema id.
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: schema.
	ObjectType string `json:"-" url:"-"`
}

func (*DeleteQualityMonitorRequest) UnmarshalJSON added in v0.73.0

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

type GetQualityMonitorRequest

type GetQualityMonitorRequest struct {
	// The uuid of the request object. For example, schema id.
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: schema.
	ObjectType string `json:"-" url:"-"`
}

func (*GetQualityMonitorRequest) UnmarshalJSON added in v0.73.0

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

type ListQualityMonitorRequest

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

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

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

func (ListQualityMonitorRequest) MarshalJSON

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

func (*ListQualityMonitorRequest) UnmarshalJSON

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

type ListQualityMonitorResponse

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

	QualityMonitors []QualityMonitor `json:"quality_monitors,omitempty"`

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

func (ListQualityMonitorResponse) MarshalJSON

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

func (*ListQualityMonitorResponse) UnmarshalJSON

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

type PercentNullValidityCheck added in v0.97.0

type PercentNullValidityCheck struct {
	// List of column names to check for null percentage
	ColumnNames []string `json:"column_names,omitempty"`
	// Optional upper bound; we should use auto determined bounds for now
	UpperBound float64 `json:"upper_bound,omitempty"`

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

func (PercentNullValidityCheck) MarshalJSON added in v0.97.0

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

func (*PercentNullValidityCheck) UnmarshalJSON added in v0.97.0

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

type QualityMonitor

type QualityMonitor struct {
	AnomalyDetectionConfig *AnomalyDetectionConfig `json:"anomaly_detection_config,omitempty"`
	// The uuid of the request object. For example, schema id.
	ObjectId string `json:"object_id"`
	// The type of the monitored object. Can be one of the following: schema.
	ObjectType string `json:"object_type"`
	// Validity check configurations for anomaly detection.
	ValidityCheckConfigurations []ValidityCheckConfiguration `json:"validity_check_configurations,omitempty"`
}

func (*QualityMonitor) UnmarshalJSON added in v0.73.0

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

type QualityMonitorV2API deprecated

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

Deprecated: Please use the Data Quality Monitoring API instead (REST: /api/data-quality/v1/monitors). Manage data quality of UC objects (currently support `schema`).

func NewQualityMonitorV2

func NewQualityMonitorV2(client *client.DatabricksClient) *QualityMonitorV2API

func (*QualityMonitorV2API) CreateQualityMonitor

func (a *QualityMonitorV2API) CreateQualityMonitor(ctx context.Context, request CreateQualityMonitorRequest) (*QualityMonitor, error)

func (*QualityMonitorV2API) DeleteQualityMonitor

func (a *QualityMonitorV2API) DeleteQualityMonitor(ctx context.Context, request DeleteQualityMonitorRequest) error

func (*QualityMonitorV2API) DeleteQualityMonitorByObjectTypeAndObjectId deprecated

func (a *QualityMonitorV2API) DeleteQualityMonitorByObjectTypeAndObjectId(ctx context.Context, objectType string, objectId string) error

Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors). Delete a quality monitor on UC object.

func (*QualityMonitorV2API) GetQualityMonitor

func (a *QualityMonitorV2API) GetQualityMonitor(ctx context.Context, request GetQualityMonitorRequest) (*QualityMonitor, error)

func (*QualityMonitorV2API) GetQualityMonitorByObjectTypeAndObjectId deprecated

func (a *QualityMonitorV2API) GetQualityMonitorByObjectTypeAndObjectId(ctx context.Context, objectType string, objectId string) (*QualityMonitor, error)

Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors). Read a quality monitor on UC object.

func (*QualityMonitorV2API) ListQualityMonitor deprecated

func (a *QualityMonitorV2API) ListQualityMonitor(ctx context.Context, request ListQualityMonitorRequest) listing.Iterator[QualityMonitor]

Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors). (Unimplemented) List quality monitors.

func (*QualityMonitorV2API) ListQualityMonitorAll deprecated

func (a *QualityMonitorV2API) ListQualityMonitorAll(ctx context.Context, request ListQualityMonitorRequest) ([]QualityMonitor, error)

Deprecated: Use Data Quality Monitoring API instead (/api/data-quality/v1/monitors). (Unimplemented) List quality monitors.

func (*QualityMonitorV2API) UpdateQualityMonitor

func (a *QualityMonitorV2API) UpdateQualityMonitor(ctx context.Context, request UpdateQualityMonitorRequest) (*QualityMonitor, error)

type QualityMonitorV2Interface

type QualityMonitorV2Interface interface {

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). Create a quality monitor on UC object.
	CreateQualityMonitor(ctx context.Context, request CreateQualityMonitorRequest) (*QualityMonitor, error)

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). Delete a quality monitor on UC object.
	DeleteQualityMonitor(ctx context.Context, request DeleteQualityMonitorRequest) error

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). Delete a quality monitor on UC object.
	DeleteQualityMonitorByObjectTypeAndObjectId(ctx context.Context, objectType string, objectId string) error

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). Read a quality monitor on UC object.
	GetQualityMonitor(ctx context.Context, request GetQualityMonitorRequest) (*QualityMonitor, error)

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). Read a quality monitor on UC object.
	GetQualityMonitorByObjectTypeAndObjectId(ctx context.Context, objectType string, objectId string) (*QualityMonitor, error)

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). (Unimplemented) List quality monitors.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListQualityMonitor(ctx context.Context, request ListQualityMonitorRequest) listing.Iterator[QualityMonitor]

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). (Unimplemented) List quality monitors.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListQualityMonitorAll(ctx context.Context, request ListQualityMonitorRequest) ([]QualityMonitor, error)

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). (Unimplemented) Update a quality monitor on
	// UC object.
	UpdateQualityMonitor(ctx context.Context, request UpdateQualityMonitorRequest) (*QualityMonitor, error)
}

type QualityMonitorV2Service deprecated

type QualityMonitorV2Service interface {

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). Create a quality monitor on UC object.
	CreateQualityMonitor(ctx context.Context, request CreateQualityMonitorRequest) (*QualityMonitor, error)

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). Delete a quality monitor on UC object.
	DeleteQualityMonitor(ctx context.Context, request DeleteQualityMonitorRequest) error

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). Read a quality monitor on UC object.
	GetQualityMonitor(ctx context.Context, request GetQualityMonitorRequest) (*QualityMonitor, error)

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). (Unimplemented) List quality monitors.
	ListQualityMonitor(ctx context.Context, request ListQualityMonitorRequest) (*ListQualityMonitorResponse, error)

	// Deprecated: Use Data Quality Monitoring API instead
	// (/api/data-quality/v1/monitors). (Unimplemented) Update a quality monitor
	// on UC object.
	UpdateQualityMonitor(ctx context.Context, request UpdateQualityMonitorRequest) (*QualityMonitor, error)
}

Deprecated: Please use the Data Quality Monitoring API instead (REST: /api/data-quality/v1/monitors). Manage data quality of UC objects (currently support `schema`).

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

type RangeValidityCheck added in v0.97.0

type RangeValidityCheck struct {
	// List of column names to check for range validity
	ColumnNames []string `json:"column_names,omitempty"`
	// Lower bound for the range
	LowerBound float64 `json:"lower_bound,omitempty"`
	// Upper bound for the range
	UpperBound float64 `json:"upper_bound,omitempty"`

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

func (RangeValidityCheck) MarshalJSON added in v0.97.0

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

func (*RangeValidityCheck) UnmarshalJSON added in v0.97.0

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

type UniquenessValidityCheck added in v0.97.0

type UniquenessValidityCheck struct {
	// List of column names to check for uniqueness
	ColumnNames []string `json:"column_names,omitempty"`
}

func (*UniquenessValidityCheck) UnmarshalJSON added in v0.174.0

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

type UpdateQualityMonitorRequest

type UpdateQualityMonitorRequest struct {
	// The uuid of the request object. For example, schema id.
	ObjectId string `json:"-" url:"-"`
	// The type of the monitored object. Can be one of the following: schema.
	ObjectType string `json:"-" url:"-"`

	QualityMonitor QualityMonitor `json:"quality_monitor"`
}

func (*UpdateQualityMonitorRequest) UnmarshalJSON added in v0.73.0

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

type ValidityCheckConfiguration added in v0.97.0

type ValidityCheckConfiguration struct {
	// Can be set by system. Does not need to be user facing.
	Name string `json:"name,omitempty"`

	PercentNullValidityCheck *PercentNullValidityCheck `json:"percent_null_validity_check,omitempty"`

	RangeValidityCheck *RangeValidityCheck `json:"range_validity_check,omitempty"`

	UniquenessValidityCheck *UniquenessValidityCheck `json:"uniqueness_validity_check,omitempty"`

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

func (ValidityCheckConfiguration) MarshalJSON added in v0.97.0

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

func (*ValidityCheckConfiguration) UnmarshalJSON added in v0.97.0

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

Jump to

Keyboard shortcuts

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