diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md index 4964d71f064..d292188f0f7 100644 --- a/NEXT_CHANGELOG.md +++ b/NEXT_CHANGELOG.md @@ -8,6 +8,7 @@ ### Bundles * `bundle run` now prints the modern job run URL (`/jobs//runs/`) so that non-admin users permitted to view the run are taken to the run instead of the workspace homepage. +* Fix missing field descriptions in the bundle JSON schema for fields whose upstream API docs arrived after the field was first annotated (e.g. `vector_search_endpoints.*.target_qps`); stale placeholder markers no longer hide them ([#5588](https://github.com/databricks/cli/pull/5588)). ### Dependency updates diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index 8f6f43a4f97..d3e105540dc 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -38,6 +38,44 @@ func newAnnotationHandler(extracted, fromFile annotation.File) (*annotationHandl }, nil } +// dropShadowingPlaceholders removes PLACEHOLDER descriptions from fromFile for +// fields that cli.json documents. A PLACEHOLDER marks a field with no +// documentation anywhere, so once upstream gains a description the marker is +// stale and would otherwise shadow it in the merge, leaving the schema with no +// description at all. fromFile is mutated in place: the sync step then rewrites +// the annotations file without the stale markers. Entries that carry other +// hand-authored fields (e.g. deprecation_message) lose only the placeholder. +func dropShadowingPlaceholders(fromFile, extracted annotation.File) { + for typePath, ta := range fromFile { + for key, d := range ta.Fields { + if d.Description != annotation.Placeholder { + continue + } + if extracted[typePath].Fields[key].Description == "" { + // Genuinely undocumented: keep the TODO marker. + continue + } + d.Description = "" + if isEmptyDescriptor(d) { + delete(ta.Fields, key) + } else { + ta.Fields[key] = d + } + } + if len(ta.Fields) == 0 && isEmptyDescriptor(ta.Self) { + delete(fromFile, typePath) + } + } +} + +// isEmptyDescriptor reports whether d carries no annotation data. It runs after +// a stale placeholder is cleared, to decide whether the whole entry can be +// dropped. Comparing against the zero value stays correct as new Descriptor +// fields are added. +func isEmptyDescriptor(d annotation.Descriptor) bool { + return reflect.DeepEqual(d, annotation.Descriptor{}) +} + // mergeAnnotationFiles merges later layers over earlier ones with the same // semantics the on-disk annotation files used to be merged with: maps merge // recursively, scalars take the later value, sequences concatenate. diff --git a/bundle/internal/schema/annotations.yml b/bundle/internal/schema/annotations.yml index 76d87429c70..217a8fc19d1 100644 --- a/bundle/internal/schema/annotations.yml +++ b/bundle/internal/schema/annotations.yml @@ -235,21 +235,6 @@ resources: "description": |- PLACEHOLDER "$fields": - "create_time": - "description": |- - PLACEHOLDER - "custom_description": - "description": |- - PLACEHOLDER - "custom_summary": - "description": |- - PLACEHOLDER - "display_name": - "description": |- - PLACEHOLDER - "effective_run_as": - "description": |- - PLACEHOLDER "evaluation": "description": |- PLACEHOLDER @@ -268,9 +253,6 @@ resources: PLACEHOLDER "source": "$fields": - "aggregation": - "description": |- - PLACEHOLDER "display": "description": |- PLACEHOLDER @@ -298,114 +280,33 @@ resources: "file_path": "description": |- PLACEHOLDER - "id": - "description": |- - PLACEHOLDER "lifecycle": "description": |- PLACEHOLDER - "lifecycle_state": - "description": |- - PLACEHOLDER - "owner_user_name": - "description": |- - PLACEHOLDER - "parent_path": - "description": |- - PLACEHOLDER "permissions": "description": |- PLACEHOLDER - "query_text": - "description": |- - PLACEHOLDER - "run_as": - "description": |- - PLACEHOLDER - "run_as_user_name": - "description": |- - PLACEHOLDER "schedule": "description": |- PLACEHOLDER - "update_time": - "description": |- - PLACEHOLDER - "warehouse_id": - "description": |- - PLACEHOLDER "apps": "description": |- The app resource defines a Databricks app. "markdown_description": |- The app resource defines a [Databricks app](/api/workspace/apps/create). For information about Databricks Apps, see [\_](/dev-tools/databricks-apps/index.md). "$fields": - "active_deployment": - "$fields": - "create_time": - "description": |- - PLACEHOLDER - "creator": - "description": |- - PLACEHOLDER - "deployment_artifacts": - "description": |- - PLACEHOLDER - "$fields": - "source_code_path": - "description": |- - PLACEHOLDER - "deployment_id": - "description": |- - PLACEHOLDER - "mode": - "description": |- - PLACEHOLDER - "source_code_path": - "description": |- - PLACEHOLDER - "status": - "description": |- - PLACEHOLDER - "$fields": - "message": - "description": |- - PLACEHOLDER - "state": - "description": |- - PLACEHOLDER - "update_time": - "description": |- - PLACEHOLDER "app_status": "description": |- PLACEHOLDER - "$fields": - "message": - "description": |- - PLACEHOLDER - "state": - "description": |- - PLACEHOLDER "budget_policy_id": "description": |- PLACEHOLDER - "compute_max_instances": - "description": |- - PLACEHOLDER - "compute_min_instances": - "description": |- - PLACEHOLDER "compute_size": "description": |- PLACEHOLDER "compute_status": "description": |- PLACEHOLDER - "$fields": - "message": - "description": |- - PLACEHOLDER "config": "description": |- PLACEHOLDER @@ -513,13 +414,6 @@ resources: "job": "description": |- PLACEHOLDER - "$fields": - "id": - "description": |- - PLACEHOLDER - "permission": - "description": |- - PLACEHOLDER "postgres": "description": |- PLACEHOLDER @@ -536,36 +430,12 @@ resources: "secret": "description": |- PLACEHOLDER - "$fields": - "key": - "description": |- - PLACEHOLDER - "permission": - "description": |- - PLACEHOLDER - "scope": - "description": |- - PLACEHOLDER "serving_endpoint": "description": |- PLACEHOLDER - "$fields": - "name": - "description": |- - PLACEHOLDER - "permission": - "description": |- - PLACEHOLDER "sql_warehouse": "description": |- PLACEHOLDER - "$fields": - "id": - "description": |- - PLACEHOLDER - "permission": - "description": |- - PLACEHOLDER "uc_securable": "description": |- PLACEHOLDER @@ -594,9 +464,6 @@ resources: "telemetry_export_destinations": "description": |- PLACEHOLDER - "thumbnail_url": - "description": |- - PLACEHOLDER "usage_policy_id": "description": |- PLACEHOLDER @@ -607,12 +474,6 @@ resources: "description": |- PLACEHOLDER "$fields": - "comment": - "description": |- - PLACEHOLDER - "connection_name": - "description": |- - PLACEHOLDER "grants": "description": |- PLACEHOLDER @@ -632,24 +493,6 @@ resources: "azure_tenant_id": "description": |- PLACEHOLDER - "name": - "description": |- - PLACEHOLDER - "options": - "description": |- - PLACEHOLDER - "properties": - "description": |- - PLACEHOLDER - "provider_name": - "description": |- - PLACEHOLDER - "share_name": - "description": |- - PLACEHOLDER - "storage_root": - "description": |- - PLACEHOLDER "clusters": "description": |- The cluster definitions for the bundle, where each key is the name of a cluster. @@ -685,15 +528,6 @@ resources: notebook_path: "./src/my_notebook.py" ``` "$fields": - "data_security_mode": - "description": |- - PLACEHOLDER - "docker_image": - "description": |- - PLACEHOLDER - "kind": - "description": |- - PLACEHOLDER "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. @@ -720,12 +554,6 @@ resources: "user_name": "description": |- PLACEHOLDER - "runtime_engine": - "description": |- - PLACEHOLDER - "workload_type": - "description": |- - PLACEHOLDER "dashboards": "description": |- The dashboard definitions for the bundle, where each key is the name of the dashboard. @@ -839,9 +667,6 @@ resources: "description": |- PLACEHOLDER "$fields": - "effective_capacity": - "description": |- - PLACEHOLDER "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. @@ -893,50 +718,17 @@ resources: "description": |- PLACEHOLDER "$fields": - "comment": - "description": |- - PLACEHOLDER - "credential_name": - "description": |- - PLACEHOLDER "effective_file_event_queue": "$fields": "managed_aqs": "description": |- PLACEHOLDER - "$fields": - "managed_resource_id": - "description": |- - PLACEHOLDER - "queue_url": - "description": |- - PLACEHOLDER - "resource_group": - "description": |- - PLACEHOLDER - "subscription_id": - "description": |- - PLACEHOLDER "managed_pubsub": "description": |- PLACEHOLDER - "$fields": - "managed_resource_id": - "description": |- - PLACEHOLDER - "subscription_name": - "description": |- - PLACEHOLDER "managed_sqs": "description": |- PLACEHOLDER - "$fields": - "managed_resource_id": - "description": |- - PLACEHOLDER - "queue_url": - "description": |- - PLACEHOLDER "provided_aqs": "description": |- PLACEHOLDER @@ -946,20 +738,11 @@ resources: "provided_sqs": "description": |- PLACEHOLDER - "enable_file_events": - "description": |- - PLACEHOLDER "encryption_details": - "description": |- - PLACEHOLDER "$fields": "sse_encryption_details": - "description": |- - PLACEHOLDER "$fields": "algorithm": - "description": |- - PLACEHOLDER "$type": "description": |- SSE algorithm to use for encrypting S3 objects @@ -968,33 +751,12 @@ resources: AWS_SSE_KMS - |- AWS_SSE_S3 - "aws_kms_key_arn": - "description": |- - PLACEHOLDER - "fallback": - "description": |- - PLACEHOLDER - "file_event_queue": - "description": |- - PLACEHOLDER "grants": "description": |- PLACEHOLDER "lifecycle": "description": |- PLACEHOLDER - "name": - "description": |- - PLACEHOLDER - "read_only": - "description": |- - PLACEHOLDER - "skip_validation": - "description": |- - PLACEHOLDER - "url": - "description": |- - PLACEHOLDER "genie_spaces": "description": |- PLACEHOLDER @@ -1053,51 +815,26 @@ resources: "environments": "$fields": "spec": - "description": |- - PLACEHOLDER "$fields": "dependencies": "description": |- List of pip dependencies, as supported by the version of pip in this environment. - "java_dependencies": - "description": |- - PLACEHOLDER "git_source": "$fields": "sparse_checkout": "description": |- PLACEHOLDER "health": - "description": |- - PLACEHOLDER "$fields": "rules": "description": |- PLACEHOLDER - "$fields": - "metric": - "description": |- - PLACEHOLDER - "op": - "description": |- - PLACEHOLDER "job_clusters": "$fields": "new_cluster": "$fields": - "aws_attributes": - "$fields": - "availability": - "description": |- - PLACEHOLDER - "ebs_volume_type": - "description": |- - PLACEHOLDER "azure_attributes": "$fields": - "availability": - "description": |- - PLACEHOLDER "log_analytics_info": "$fields": "log_analytics_primary_key": @@ -1106,35 +843,11 @@ resources: "log_analytics_workspace_id": "description": |- The workspace ID for the Azure Log Analytics agent configuration - "data_security_mode": - "description": |- - PLACEHOLDER - "docker_image": - "description": |- - PLACEHOLDER - "$fields": - "basic_auth": - "description": |- - PLACEHOLDER - "gcp_attributes": - "$fields": - "availability": - "description": |- - PLACEHOLDER "init_scripts": "$fields": "abfss": "description": |- Contains the Azure Data Lake Storage destination path - "kind": - "description": |- - PLACEHOLDER - "runtime_engine": - "description": |- - PLACEHOLDER - "workload_type": - "description": |- - PLACEHOLDER "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. @@ -1159,8 +872,6 @@ resources: "description": |- PLACEHOLDER "run_as": - "description": |- - PLACEHOLDER "$fields": "service_principal_name": "description": |- @@ -1177,25 +888,6 @@ resources: "destination_id": "description": |- PLACEHOLDER - "dashboard_task": - "$fields": - "dashboard_id": - "description": |- - PLACEHOLDER - "subscription": - "description": |- - PLACEHOLDER - "$fields": - "subscribers": - "description": |- - PLACEHOLDER - "$fields": - "destination_id": - "description": |- - PLACEHOLDER - "user_name": - "description": |- - PLACEHOLDER "dbt_platform_task": "description": |- PLACEHOLDER @@ -1206,9 +898,6 @@ resources: "compute": "description": |- PLACEHOLDER - "health": - "description": |- - PLACEHOLDER "python_operator_task": "$fields": "parameters": @@ -1373,18 +1062,8 @@ resources: "$fields": "ingestion_definition": "$fields": - "netsuite_jar_path": - "description": |- - PLACEHOLDER "objects": "$fields": - "report": - "$fields": - "table_configuration": - "$fields": - "workday_report_parameters": - "description": |- - PLACEHOLDER "schema": "$fields": "connector_options": @@ -1440,9 +1119,6 @@ resources: "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. - "parameters": - "description": |- - PLACEHOLDER "permissions": "description": |- PLACEHOLDER @@ -1459,9 +1135,6 @@ resources: "user_name": "description": |- PLACEHOLDER - "run_as": - "description": |- - PLACEHOLDER "trigger": "deprecation_message": |- Use continuous instead @@ -1782,52 +1455,12 @@ resources: principal: account users ``` "$fields": - "aliases": - "description": |- - PLACEHOLDER - "$fields": - "catalog_name": - "description": |- - PLACEHOLDER - "id": - "description": |- - PLACEHOLDER - "model_name": - "description": |- - PLACEHOLDER - "schema_name": - "description": |- - PLACEHOLDER - "browse_only": - "description": |- - PLACEHOLDER - "created_at": - "description": |- - PLACEHOLDER - "created_by": - "description": |- - PLACEHOLDER - "full_name": - "description": |- - PLACEHOLDER "grants": "description": |- PLACEHOLDER "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. - "metastore_id": - "description": |- - PLACEHOLDER - "owner": - "description": |- - PLACEHOLDER - "updated_at": - "description": |- - PLACEHOLDER - "updated_by": - "description": |- - PLACEHOLDER "schemas": "description": |- The schema definitions for the bundle, where each key is the name of the schema. @@ -1886,9 +1519,6 @@ resources: "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. - "properties": - "description": |- - PLACEHOLDER "secret_scopes": "description": |- The secret scope definitions for the bundle, where each key is the name of the secret scope. @@ -1969,9 +1599,6 @@ resources: "user_name": "description": |- PLACEHOLDER - "spot_instance_policy": - "description": |- - PLACEHOLDER "tags": "$fields": "custom_tags": @@ -1984,148 +1611,40 @@ resources: "value": "description": |- PLACEHOLDER - "warehouse_type": - "description": |- - PLACEHOLDER "synced_database_tables": "description": |- PLACEHOLDER "$fields": "data_synchronization_status": - "description": |- - PLACEHOLDER "$fields": "last_sync": "$fields": "delta_table_sync_info": "description": |- PLACEHOLDER - "database_instance_name": - "description": |- - PLACEHOLDER - "effective_database_instance_name": - "description": |- - PLACEHOLDER - "effective_logical_database_name": - "description": |- - PLACEHOLDER "lifecycle": "description": |- PLACEHOLDER - "logical_database_name": - "description": |- - PLACEHOLDER - "name": - "description": |- - PLACEHOLDER - "spec": - "description": |- - PLACEHOLDER - "unity_catalog_provisioning_state": - "description": |- - PLACEHOLDER "vector_search_endpoints": "description": |- PLACEHOLDER "$fields": - "budget_policy_id": - "description": |- - PLACEHOLDER - "endpoint_type": - "description": |- - PLACEHOLDER "lifecycle": "description": |- PLACEHOLDER - "name": - "description": |- - PLACEHOLDER "permissions": "description": |- PLACEHOLDER - "target_qps": - "description": |- - PLACEHOLDER - "usage_policy_id": - "description": |- - PLACEHOLDER "vector_search_indexes": "description": |- PLACEHOLDER "$fields": - "delta_sync_index_spec": - "description": |- - PLACEHOLDER - "$fields": - "columns_to_sync": - "description": |- - PLACEHOLDER - "embedding_source_columns": - "description": |- - PLACEHOLDER - "$fields": - "embedding_model_endpoint_name": - "description": |- - PLACEHOLDER - "model_endpoint_name_for_query": - "description": |- - PLACEHOLDER - "name": - "description": |- - PLACEHOLDER - "embedding_vector_columns": - "description": |- - PLACEHOLDER - "$fields": - "embedding_dimension": - "description": |- - PLACEHOLDER - "name": - "description": |- - PLACEHOLDER - "embedding_writeback_table": - "description": |- - PLACEHOLDER - "pipeline_type": - "description": |- - PLACEHOLDER - "source_table": - "description": |- - PLACEHOLDER - "direct_access_index_spec": - "description": |- - PLACEHOLDER - "$fields": - "embedding_source_columns": - "description": |- - PLACEHOLDER - "embedding_vector_columns": - "description": |- - PLACEHOLDER - "schema_json": - "description": |- - PLACEHOLDER - "endpoint_name": - "description": |- - PLACEHOLDER "grants": "description": |- PLACEHOLDER - "index_subtype": - "description": |- - PLACEHOLDER - "index_type": - "description": |- - PLACEHOLDER "lifecycle": "description": |- PLACEHOLDER - "name": - "description": |- - PLACEHOLDER - "primary_key": - "description": |- - PLACEHOLDER "volumes": "description": |- The volume definitions for the bundle, where each key is the name of the volume. @@ -2158,9 +1677,6 @@ resources: "lifecycle": "description": |- Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. - "volume_type": - "description": |- - PLACEHOLDER run_as: "description": |- The identity to use when running Declarative Automation Bundles resources. diff --git a/bundle/internal/schema/annotations_test.go b/bundle/internal/schema/annotations_test.go index e4f3a7e851d..7caaa0d29df 100644 --- a/bundle/internal/schema/annotations_test.go +++ b/bundle/internal/schema/annotations_test.go @@ -7,6 +7,7 @@ import ( "github.com/databricks/cli/internal/clijson" "github.com/databricks/cli/libs/jsonschema" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestConvertLinksToAbsoluteUrl(t *testing.T) { @@ -52,6 +53,103 @@ func TestConvertLinksToAbsoluteUrl(t *testing.T) { } } +const testTypePath = "github.com/databricks/cli/bundle/config.Foo" + +func TestDropShadowingPlaceholders(t *testing.T) { + tests := []struct { + name string + fromFile annotation.File + extracted annotation.File + want annotation.File + }{ + { + name: "placeholder shadowing an upstream description is dropped", + fromFile: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: annotation.Placeholder}}}, + }, + extracted: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: "upstream description"}}}, + }, + want: annotation.File{}, + }, + { + name: "placeholder without upstream description is kept", + fromFile: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: annotation.Placeholder}}}, + }, + extracted: annotation.File{}, + want: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: annotation.Placeholder}}}, + }, + }, + { + name: "placeholder with other fields loses only the placeholder", + fromFile: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: annotation.Placeholder, DeprecationMessage: "deprecated"}}}, + }, + extracted: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: "upstream description"}}}, + }, + want: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {DeprecationMessage: "deprecated"}}}, + }, + }, + { + name: "real description override is untouched", + fromFile: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: "hand-written override"}}}, + }, + extracted: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: "upstream description"}}}, + }, + want: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: "hand-written override"}}}, + }, + }, + { + name: "other fields of the same type are kept", + fromFile: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{ + "stale": {Description: annotation.Placeholder}, + "todo": {Description: annotation.Placeholder}, + }}, + }, + extracted: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"stale": {Description: "upstream description"}}}, + }, + want: annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"todo": {Description: annotation.Placeholder}}}, + }, + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + dropShadowingPlaceholders(test.fromFile, test.extracted) + assert.Equal(t, test.want, test.fromFile) + }) + } +} + +// A stale placeholder must not swallow the upstream description in the merged +// view the schema is generated from. +func TestStalePlaceholderDoesNotShadowMergedDescription(t *testing.T) { + extracted := annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: "upstream description"}}}, + } + fromFile := annotation.File{ + testTypePath: {Fields: map[string]annotation.Descriptor{"field": {Description: annotation.Placeholder, DeprecationMessage: "deprecated"}}}, + } + + dropShadowingPlaceholders(fromFile, extracted) + h, err := newAnnotationHandler(extracted, fromFile) + require.NoError(t, err) + + merged := h.parsedAnnotations[testTypePath].Fields["field"] + assert.Equal(t, "upstream description", merged.Description) + assert.Equal(t, "deprecated", merged.DeprecationMessage) +} + func TestAssignAnnotationLaunchStage(t *testing.T) { t.Run("public preview prefixes description and stays suggestible", func(t *testing.T) { s := &jsonschema.Schema{} diff --git a/bundle/internal/schema/main.go b/bundle/internal/schema/main.go index 8b3c7301778..3f468852a83 100644 --- a/bundle/internal/schema/main.go +++ b/bundle/internal/schema/main.go @@ -266,6 +266,12 @@ func generateSchema(workdir, outputFile, cliJSONFile string, docsMode bool) { fmt.Printf("Dropping annotation at `%s`: no matching field in the bundle configuration\n", k) } + // fromFile feeds both the merge in newAnnotationHandler and the + // annotations-file rewrite in syncWithMissingAnnotations, so drop stale + // placeholders first: a marker upstream now documents would otherwise + // shadow the real description. + dropShadowingPlaceholders(fromFile, extracted) + a, err := newAnnotationHandler(extracted, fromFile) if err != nil { log.Fatal(err) diff --git a/bundle/internal/schema/main_test.go b/bundle/internal/schema/main_test.go index 393674690fc..c1f0f76bfc3 100644 --- a/bundle/internal/schema/main_test.go +++ b/bundle/internal/schema/main_test.go @@ -61,16 +61,29 @@ func TestRequiredAnnotationsForNewFields(t *testing.T) { current, err := yamlloader.LoadYAML("", bytes.NewBuffer(currentFile)) require.NoError(t, err) - // Collect added paths. - var updatedFieldPaths []string + // Regenerating from the committed file must be a no-op: no new placeholders + // (a new undocumented config field) and no deletes/updates (stale + // placeholders not yet pruned). VisitDelete/VisitUpdate must be set or + // Override panics on any change. + var addedFieldPaths []string + var changedFieldPaths []string _, err = merge.Override(original, current, merge.OverrideVisitor{ VisitInsert: func(basePath dyn.Path, right dyn.Value) (dyn.Value, error) { - updatedFieldPaths = append(updatedFieldPaths, basePath.String()) + addedFieldPaths = append(addedFieldPaths, basePath.String()) + return right, nil + }, + VisitDelete: func(basePath dyn.Path, left dyn.Value) error { + changedFieldPaths = append(changedFieldPaths, basePath.String()) + return nil + }, + VisitUpdate: func(basePath dyn.Path, left, right dyn.Value) (dyn.Value, error) { + changedFieldPaths = append(changedFieldPaths, basePath.String()) return right, nil }, }) assert.NoError(t, err) - assert.Empty(t, updatedFieldPaths, "Missing JSON-schema descriptions for new config fields in bundle/internal/schema/annotations.yml:\n%s", strings.Join(updatedFieldPaths, "\n")) + assert.Empty(t, addedFieldPaths, "Missing JSON-schema descriptions for new config fields in bundle/internal/schema/annotations.yml:\n%s", strings.Join(addedFieldPaths, "\n")) + assert.Empty(t, changedFieldPaths, "annotations.yml is out of sync; run `./task generate-schema` and commit the result:\n%s", strings.Join(changedFieldPaths, "\n")) } // Checks that the annotations file only contains entries that match the diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 36c65a4f841..ff126c8bd6e 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -80,15 +80,15 @@ "type": "object", "properties": { "custom_description": { - "description": "[Public Preview]", + "description": "[Public Preview] Custom description for the alert. support mustache template.", "$ref": "#/$defs/string" }, "custom_summary": { - "description": "[Public Preview]", + "description": "[Public Preview] Custom summary for the alert. support mustache template.", "$ref": "#/$defs/string" }, "display_name": { - "description": "[Public Preview]", + "description": "[Public Preview] The display name of the alert.", "$ref": "#/$defs/string" }, "evaluation": { @@ -102,22 +102,22 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "parent_path": { - "description": "[Public Preview]", + "description": "[Public Preview] The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.", "$ref": "#/$defs/string" }, "permissions": { "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" }, "query_text": { - "description": "[Public Preview]", + "description": "[Public Preview] Text of the query to be run.", "$ref": "#/$defs/string" }, "run_as": { - "description": "[Public Preview]", + "description": "[Public Preview] Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs" }, "run_as_user_name": { - "description": "[Public Preview]", + "description": "[Public Preview] The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", "$ref": "#/$defs/string", "deprecationMessage": "This field is deprecated", "deprecated": true @@ -127,7 +127,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule" }, "warehouse_id": { - "description": "[Public Preview]", + "description": "[Public Preview] ID of the SQL warehouse attached to the alert.", "$ref": "#/$defs/string" } }, @@ -156,13 +156,13 @@ "$ref": "#/$defs/string" }, "compute_max_instances": { - "description": "[Private Preview]", + "description": "[Private Preview] Maximum number of app instances. Must be set together with `compute_min_instances`.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "compute_min_instances": { - "description": "[Private Preview]", + "description": "[Private Preview] Minimum number of app instances. Must be set together with `compute_max_instances`.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true @@ -314,9 +314,11 @@ "type": "object", "properties": { "comment": { + "description": "User-provided free-form text description.", "$ref": "#/$defs/string" }, "connection_name": { + "description": "The name of the connection to an external data source.", "$ref": "#/$defs/string" }, "grants": { @@ -330,21 +332,27 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionSettings" }, "name": { + "description": "Name of catalog.", "$ref": "#/$defs/string" }, "options": { + "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string" }, "properties": { + "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string" }, "provider_name": { + "description": "The name of delta sharing provider.\n\nA Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.", "$ref": "#/$defs/string" }, "share_name": { + "description": "The name of the share under the share provider.", "$ref": "#/$defs/string" }, "storage_root": { + "description": "Storage root URL for managed tables within catalog.", "$ref": "#/$defs/string" } }, @@ -398,9 +406,11 @@ "$ref": "#/$defs/map/string" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode" }, "docker_image": { + "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage" }, "driver_instance_pool_id": { @@ -440,6 +450,7 @@ "$ref": "#/$defs/bool" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind" }, "lifecycle": { @@ -466,6 +477,7 @@ "$ref": "#/$defs/int" }, "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine" }, "single_user_name": { @@ -501,6 +513,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility" }, "workload_type": { + "description": "Cluster Attributes showing for clusters workload types.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType" } }, @@ -728,21 +741,27 @@ "type": "object", "properties": { "comment": { + "description": "User-provided free-form text description.", "$ref": "#/$defs/string" }, "credential_name": { + "description": "Name of the storage credential used with this location.", "$ref": "#/$defs/string" }, "enable_file_events": { + "description": "Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events.\nThe actual applied value may differ due to server-side defaults; check `effective_enable_file_events` for the effective state.", "$ref": "#/$defs/bool" }, "encryption_details": { + "description": "Encryption options that apply to clients connecting to cloud storage.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionDetails" }, "fallback": { + "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.", "$ref": "#/$defs/bool" }, "file_event_queue": { + "description": "File event queue settings. If `enable_file_events` is not `false`, must be defined and have exactly one of the documented properties.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.FileEventQueue" }, "grants": { @@ -752,15 +771,19 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { + "description": "Name of the external location.", "$ref": "#/$defs/string" }, "read_only": { + "description": "Indicates whether the external location is read-only.", "$ref": "#/$defs/bool" }, "skip_validation": { + "description": "Skips validation of the storage credential associated with the external location.", "$ref": "#/$defs/bool" }, "url": { + "description": "Path URL of the external location.", "$ref": "#/$defs/string" } }, @@ -854,6 +877,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GitSource" }, "health": { + "description": "An optional set of health rules that can be defined for this job.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules" }, "job_clusters": { @@ -892,6 +916,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings" }, "run_as": { + "description": "The user or service principal that the job runs as, if specified in the request.\nThis field indicates the explicit configuration of `run_as` for the job.\nTo find the value in all cases, explicit or implicit, use `run_as_user_name`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs" }, "schedule": { @@ -1343,7 +1368,7 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications" }, "parameters": { - "description": "[Beta]", + "description": "[Beta] Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", "$ref": "#/$defs/map/string" }, "permissions": { @@ -1364,6 +1389,7 @@ "$ref": "#/$defs/string" }, "run_as": { + "description": "Write-only setting, available only in Create/Update calls. Specifies the user or service principal that the pipeline runs as. If not specified, the pipeline runs as the user who created the pipeline.\n\nOnly `user_name` or `service_principal_name` can be specified. If both are specified, an error is thrown.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RunAs" }, "schema": { @@ -1853,9 +1879,11 @@ "type": "object", "properties": { "aliases": { + "description": "List of aliases associated with the registered model", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RegisteredModelAlias" }, "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", "$ref": "#/$defs/bool" }, "catalog_name": { @@ -1867,12 +1895,15 @@ "$ref": "#/$defs/string" }, "created_at": { + "description": "Creation timestamp of the registered model in milliseconds since the Unix epoch", "$ref": "#/$defs/int64" }, "created_by": { + "description": "The identifier of the user who created the registered model", "$ref": "#/$defs/string" }, "full_name": { + "description": "The three-level (fully qualified) name of the registered model", "$ref": "#/$defs/string" }, "grants": { @@ -1883,6 +1914,7 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "metastore_id": { + "description": "The unique identifier of the metastore", "$ref": "#/$defs/string" }, "name": { @@ -1890,6 +1922,7 @@ "$ref": "#/$defs/string" }, "owner": { + "description": "The identifier of the user who owns the registered model", "$ref": "#/$defs/string" }, "schema_name": { @@ -1901,9 +1934,11 @@ "$ref": "#/$defs/string" }, "updated_at": { + "description": "Last-update timestamp of the registered model in milliseconds since the Unix epoch", "$ref": "#/$defs/int64" }, "updated_by": { + "description": "The identifier of the user who updated the registered model last time", "$ref": "#/$defs/string" } }, @@ -1941,6 +1976,7 @@ "$ref": "#/$defs/string" }, "properties": { + "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string" }, "storage_root": { @@ -2103,6 +2139,7 @@ "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.SqlWarehousePermission" }, "spot_instance_policy": { + "description": "Configurations whether the endpoint should use spot instances.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SpotInstancePolicy" }, "tags": { @@ -2110,6 +2147,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.EndpointTags" }, "warehouse_type": { + "description": "Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,\nyou must set to `PRO` and also set the field `enable_serverless_compute` to `true`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CreateWarehouseRequestWarehouseType" } }, @@ -2156,22 +2194,22 @@ "type": "object", "properties": { "database_instance_name": { - "description": "[Public Preview]", + "description": "[Public Preview] Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", "$ref": "#/$defs/string" }, "lifecycle": { "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "logical_database_name": { - "description": "[Public Preview]", + "description": "[Public Preview] Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the `create_database_objects_is_missing` field in `spec`.", "$ref": "#/$defs/string" }, "name": { - "description": "[Public Preview]", + "description": "[Public Preview] Full three-part (catalog, schema, table) name of the table.", "$ref": "#/$defs/string" }, "spec": { - "description": "[Public Preview]", + "description": "[Public Preview] Specification of a synced database table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec" } }, @@ -2192,27 +2230,29 @@ "type": "object", "properties": { "budget_policy_id": { - "description": "[Public Preview]", + "description": "[Public Preview] The budget policy id to be applied", "$ref": "#/$defs/string" }, "endpoint_type": { + "description": "Type of endpoint", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType" }, "lifecycle": { "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { + "description": "Name of the AI Search endpoint", "$ref": "#/$defs/string" }, "permissions": { "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" }, "target_qps": { - "description": "[Public Preview]", + "description": "[Public Preview] Target QPS for the endpoint. Mutually exclusive with num_replicas.\nThe actual replica count is calculated at index creation/sync time based on this value.\nBest-effort target; the system does not guarantee this QPS will be achieved.", "$ref": "#/$defs/int64" }, "usage_policy_id": { - "description": "[Private Preview]", + "description": "[Private Preview] The usage policy id to be applied once we've migrated to usage policies", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true @@ -2236,31 +2276,37 @@ "type": "object", "properties": { "delta_sync_index_spec": { + "description": "Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.DeltaSyncVectorIndexSpecRequest" }, "direct_access_index_spec": { + "description": "Specification for Direct Vector Access Index. Required if `index_type` is `DIRECT_ACCESS`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.DirectAccessVectorIndexSpec" }, "endpoint_name": { + "description": "Name of the endpoint to be used for serving the index", "$ref": "#/$defs/string" }, "grants": { "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" }, "index_subtype": { - "description": "[Beta]", + "description": "[Beta] The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype" }, "index_type": { + "description": "There are 2 types of AI Search indexes:\n- `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.\n- `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType" }, "lifecycle": { "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { + "description": "Name of the index", "$ref": "#/$defs/string" }, "primary_key": { + "description": "Primary key of the index", "$ref": "#/$defs/string" } }, @@ -2311,6 +2357,7 @@ "$ref": "#/$defs/string" }, "volume_type": { + "description": "The type of the volume. An external volume is located in the specified external location.\nA managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.\n[Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.VolumeType" } }, @@ -3152,6 +3199,7 @@ "$ref": "#/$defs/slice/string" }, "deployment_id": { + "description": "The unique id of the deployment.", "$ref": "#/$defs/string" }, "env_vars": { @@ -3163,9 +3211,11 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitSource" }, "mode": { + "description": "The mode of which the deployment will manage the source code.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentMode" }, "source_code_path": { + "description": "The workspace file system path of the source code used to create the app deployment. This is different from\n`deployment_artifacts.source_code_path`, which is the path used by the deployed app. The former refers\nto the original source code location of the app in the workspace during deployment creation, whereas\nthe latter provides a system generated stable snapshotted source code path used by the deployment.", "$ref": "#/$defs/string" } }, @@ -3183,6 +3233,7 @@ "type": "object", "properties": { "source_code_path": { + "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.", "$ref": "#/$defs/string" } }, @@ -3476,9 +3527,11 @@ "type": "object", "properties": { "id": { + "description": "Id of the job to grant permission on.", "$ref": "#/$defs/string" }, "permission": { + "description": "Permissions to grant on the Job. Supported permissions are: \"CAN_MANAGE\", \"IS_OWNER\", \"CAN_MANAGE_RUN\", \"CAN_VIEW\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJobJobPermission" } }, @@ -3554,12 +3607,15 @@ "type": "object", "properties": { "key": { + "description": "Key of the secret to grant permission on.", "$ref": "#/$defs/string" }, "permission": { + "description": "Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: \"READ\", \"WRITE\", \"MANAGE\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecretSecretPermission" }, "scope": { + "description": "Scope of the secret to grant permission on.", "$ref": "#/$defs/string" } }, @@ -3599,9 +3655,11 @@ "type": "object", "properties": { "name": { + "description": "Name of the serving endpoint to grant permission on.", "$ref": "#/$defs/string" }, "permission": { + "description": "Permission to grant on the serving endpoint. Supported permissions are: \"CAN_MANAGE\", \"CAN_QUERY\", \"CAN_VIEW\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpointServingEndpointPermission" } }, @@ -3639,9 +3697,11 @@ "type": "object", "properties": { "id": { + "description": "Id of the SQL warehouse to grant permission on.", "$ref": "#/$defs/string" }, "permission": { + "description": "Permission to grant on the SQL warehouse. Supported permissions are: \"CAN_MANAGE\", \"CAN_USE\", \"IS_OWNER\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouseSqlWarehousePermission" } }, @@ -3954,6 +4014,7 @@ "type": "object", "properties": { "queue_url": { + "description": "The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}.\nOnly required for provided_sqs.", "$ref": "#/$defs/string" } }, @@ -3997,12 +4058,15 @@ "type": "object", "properties": { "queue_url": { + "description": "The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name}\nOnly required for provided_aqs.", "$ref": "#/$defs/string" }, "resource_group": { + "description": "Optional resource group for the queue, event grid subscription, and external location storage\naccount.\nOnly required for locations with a service principal storage credential", "$ref": "#/$defs/string" }, "subscription_id": { + "description": "Optional subscription id for the queue, event grid subscription, and external location storage\naccount.\nRequired for locations with a service principal storage credential", "$ref": "#/$defs/string" } }, @@ -4021,6 +4085,7 @@ "description": "Encryption options that apply to clients connecting to cloud storage.", "properties": { "sse_encryption_details": { + "description": "Server-Side Encryption properties for clients communicating with AWS s3.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.SseEncryptionDetails" } }, @@ -4097,6 +4162,7 @@ "type": "object", "properties": { "subscription_name": { + "description": "The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}.\nOnly required for provided_pubsub.", "$ref": "#/$defs/string" } }, @@ -4476,15 +4542,19 @@ "$ref": "#/$defs/string" }, "catalog_name": { + "description": "The name of the catalog containing the model version", "$ref": "#/$defs/string" }, "id": { + "description": "The unique identifier of the alias", "$ref": "#/$defs/string" }, "model_name": { + "description": "The name of the parent registered model of the model version, relative to parent schema", "$ref": "#/$defs/string" }, "schema_name": { + "description": "The name of the schema containing the model version, relative to parent catalog", "$ref": "#/$defs/string" }, "version_num": { @@ -4507,9 +4577,11 @@ "description": "Server-Side Encryption properties for clients communicating with AWS s3.", "properties": { "algorithm": { + "description": "Sets the value of the 'x-amz-server-side-encryption' header in S3 request.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.SseEncryptionDetailsAlgorithm" }, "aws_kms_key_arn": { + "description": "Optional. The ARN of the SSE-KMS key used with the S3 location, when algorithm = \"SSE-KMS\".\nSets the value of the 'x-amz-server-side-encryption-aws-kms-key-id' header.", "$ref": "#/$defs/string" } }, @@ -4605,6 +4677,7 @@ "description": "Attributes set during cluster creation which are related to Amazon Web Services.", "properties": { "availability": { + "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\n\nNote: If `first_on_demand` is zero, this availability type will be used for the entire cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAvailability" }, "ebs_volume_count": { @@ -4624,6 +4697,7 @@ "$ref": "#/$defs/int" }, "ebs_volume_type": { + "description": "The type of EBS volumes that will be launched with this cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.EbsVolumeType" }, "first_on_demand": { @@ -4675,6 +4749,7 @@ "description": "Attributes set during cluster creation which are related to Microsoft Azure.", "properties": { "availability": { + "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\nNote: If `first_on_demand` is zero, this availability\ntype will be used for the entire cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAvailability" }, "first_on_demand": { @@ -4820,9 +4895,11 @@ "$ref": "#/$defs/map/string" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode" }, "docker_image": { + "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage" }, "driver_instance_pool_id": { @@ -4862,6 +4939,7 @@ "$ref": "#/$defs/bool" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind" }, "node_type_id": { @@ -4881,6 +4959,7 @@ "$ref": "#/$defs/int" }, "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine" }, "single_user_name": { @@ -4916,6 +4995,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility" }, "workload_type": { + "description": "Cluster Attributes showing for clusters workload types.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType" } }, @@ -5033,6 +5113,7 @@ "type": "object", "properties": { "basic_auth": { + "description": "Basic auth with username and password", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerBasicAuth" }, "url": { @@ -5089,7 +5170,7 @@ "$ref": "#/$defs/string" }, "java_dependencies": { - "description": "[Public Preview]", + "description": "[Public Preview] List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`.", "$ref": "#/$defs/slice/string" } }, @@ -5108,6 +5189,7 @@ "description": "Attributes set during cluster creation which are related to GCP.", "properties": { "availability": { + "description": "This field determines whether the spark executors will be scheduled to run on preemptible\nVMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability" }, "boot_disk_size": { @@ -6312,6 +6394,7 @@ "description": "Configures the Lakeview Dashboard job task type.", "properties": { "dashboard_id": { + "description": "The identifier of the dashboard to refresh.", "$ref": "#/$defs/string" }, "filters": { @@ -6321,6 +6404,7 @@ "doNotSuggest": true }, "subscription": { + "description": "Optional: subscription configuration for sending the dashboard snapshot.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Subscription" }, "warehouse_id": { @@ -6796,6 +6880,7 @@ "$ref": "#/$defs/string" }, "spec": { + "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip and java dependencies are supported.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Environment" } }, @@ -7009,9 +7094,11 @@ "type": "object", "properties": { "metric": { + "description": "Specifies the health metric that is being evaluated for a particular health rule.\n\n* `RUN_DURATION_SECONDS`: Expected total time for a run in seconds.\n* `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric" }, "op": { + "description": "Specifies the operator used to compare the health metric value with the specified threshold.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthOperator" }, "value": { @@ -7946,6 +8033,7 @@ "$ref": "#/$defs/bool" }, "subscribers": { + "description": "The list of subscribers to send the snapshot of the dashboard to.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionSubscriber" } }, @@ -7963,9 +8051,11 @@ "type": "object", "properties": { "destination_id": { + "description": "A snapshot of the dashboard will be sent to the destination when the `destination_id` field is present.", "$ref": "#/$defs/string" }, "user_name": { + "description": "A snapshot of the dashboard will be sent to the user's email when the `user_name` field is present.", "$ref": "#/$defs/string" } }, @@ -8092,6 +8182,7 @@ "doNotSuggest": true }, "health": { + "description": "An optional set of health rules that can be defined for this job.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules" }, "job_cluster_key": { @@ -9186,7 +9277,7 @@ "$ref": "#/$defs/string" }, "netsuite_jar_path": { - "description": "[Private Preview]", + "description": "[Private Preview] Netsuite only configuration. When the field is set for a netsuite connector,\nthe jar stored in the field will be validated and added to the classpath of\npipeline's cluster.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true @@ -10415,7 +10506,7 @@ "$ref": "#/$defs/slice/string" }, "workday_report_parameters": { - "description": "[Private Preview]", + "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true @@ -12236,7 +12327,7 @@ "type": "object", "properties": { "aggregation": { - "description": "[Public Preview]", + "description": "[Public Preview] If not set, the behavior is equivalent to using `First row` in the UI.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation" }, "display": { @@ -12546,21 +12637,27 @@ "$ref": "#/$defs/slice/string" }, "columns_to_sync": { + "description": "[Optional] Select the columns to sync with the vector index. If you leave this field blank, all columns\nfrom the source table are synced with the index. The primary key column and embedding source column or\nembedding vector column are always synced.", "$ref": "#/$defs/slice/string" }, "embedding_source_columns": { + "description": "The columns that contain the embedding source.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn" }, "embedding_vector_columns": { + "description": "The columns that contain the embedding vectors.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn" }, "embedding_writeback_table": { + "description": "[Optional] Name of the Delta table to sync the vector index contents and computed embeddings to.", "$ref": "#/$defs/string" }, "pipeline_type": { + "description": "Pipeline execution mode.\n- `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.\n- `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.PipelineType" }, "source_table": { + "description": "The name of the source table.", "$ref": "#/$defs/string" } }, @@ -12578,12 +12675,15 @@ "type": "object", "properties": { "embedding_source_columns": { + "description": "The columns that contain the embedding source. The format should be array[double].", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn" }, "embedding_vector_columns": { + "description": "The columns that contain the embedding vectors. The format should be array[double].", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn" }, "schema_json": { + "description": "The schema of the index in JSON format.\nSupported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.\nSupported types for vector column: `array\u003cfloat\u003e`, `array\u003cdouble\u003e`,`.", "$ref": "#/$defs/string" } }, @@ -12601,12 +12701,15 @@ "type": "object", "properties": { "embedding_model_endpoint_name": { + "description": "Name of the embedding model endpoint, used by default for both ingestion and querying.", "$ref": "#/$defs/string" }, "model_endpoint_name_for_query": { + "description": "Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).", "$ref": "#/$defs/string" }, "name": { + "description": "Name of the column", "$ref": "#/$defs/string" } }, @@ -12624,9 +12727,11 @@ "type": "object", "properties": { "embedding_dimension": { + "description": "Dimension of the embedding vector", "$ref": "#/$defs/int" }, "name": { + "description": "Name of the column", "$ref": "#/$defs/string" } }, diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index e61e22de80b..526327f4b2c 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -22,17 +22,17 @@ "type": "object", "properties": { "custom_description": { - "description": "[Public Preview]", + "description": "[Public Preview] Custom description for the alert. support mustache template.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "custom_summary": { - "description": "[Public Preview]", + "description": "[Public Preview] Custom summary for the alert. support mustache template.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "display_name": { - "description": "[Public Preview]", + "description": "[Public Preview] The display name of the alert.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, @@ -50,7 +50,7 @@ "x-since-version": "v0.279.0" }, "parent_path": { - "description": "[Public Preview]", + "description": "[Public Preview] The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, @@ -59,17 +59,17 @@ "x-since-version": "v0.279.0" }, "query_text": { - "description": "[Public Preview]", + "description": "[Public Preview] Text of the query to be run.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "run_as": { - "description": "[Public Preview]", + "description": "[Public Preview] Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs", "x-since-version": "v0.279.0" }, "run_as_user_name": { - "description": "[Public Preview]", + "description": "[Public Preview] The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", "$ref": "#/$defs/string", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.279.0", @@ -81,7 +81,7 @@ "x-since-version": "v0.279.0" }, "warehouse_id": { - "description": "[Public Preview]", + "description": "[Public Preview] ID of the SQL warehouse attached to the alert.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -104,14 +104,14 @@ "x-since-version": "v0.243.0" }, "compute_max_instances": { - "description": "[Private Preview]", + "description": "[Private Preview] Maximum number of app instances. Must be set together with `compute_min_instances`.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, "compute_min_instances": { - "description": "[Private Preview]", + "description": "[Private Preview] Minimum number of app instances. Must be set together with `compute_max_instances`.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -255,10 +255,12 @@ "type": "object", "properties": { "comment": { + "description": "User-provided free-form text description.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "connection_name": { + "description": "The name of the connection to an external data source.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, @@ -276,26 +278,32 @@ "x-since-version": "v0.298.0" }, "name": { + "description": "Name of catalog.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "options": { + "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string", "x-since-version": "v0.287.0" }, "properties": { + "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string", "x-since-version": "v0.287.0" }, "provider_name": { + "description": "The name of delta sharing provider.\n\nA Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "share_name": { + "description": "The name of the share under the share provider.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "storage_root": { + "description": "Storage root URL for managed tables within catalog.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" } @@ -350,10 +358,12 @@ "x-since-version": "v0.229.0" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", "x-since-version": "v0.229.0" }, "docker_image": { + "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", "x-since-version": "v0.229.0" }, @@ -403,6 +413,7 @@ "x-since-version": "v0.237.0" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind", "x-since-version": "v0.237.0" }, @@ -436,6 +447,7 @@ "x-since-version": "v0.257.0" }, "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine", "x-since-version": "v0.229.0" }, @@ -480,6 +492,7 @@ "x-since-version": "v0.285.0" }, "workload_type": { + "description": "Cluster Attributes showing for clusters workload types.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType", "x-since-version": "v0.229.0" } @@ -705,26 +718,32 @@ "type": "object", "properties": { "comment": { + "description": "User-provided free-form text description.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" }, "credential_name": { + "description": "Name of the storage credential used with this location.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" }, "enable_file_events": { + "description": "Whether to enable file events on this external location. Default to `true`. Set to `false` to disable file events.\nThe actual applied value may differ due to server-side defaults; check `effective_enable_file_events` for the effective state.", "$ref": "#/$defs/bool", "x-since-version": "v0.289.0" }, "encryption_details": { + "description": "Encryption options that apply to clients connecting to cloud storage.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionDetails", "x-since-version": "v0.289.0" }, "fallback": { + "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.", "$ref": "#/$defs/bool", "x-since-version": "v0.289.0" }, "file_event_queue": { + "description": "File event queue settings. If `enable_file_events` is not `false`, must be defined and have exactly one of the documented properties.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.FileEventQueue", "x-since-version": "v0.289.0" }, @@ -737,18 +756,22 @@ "x-since-version": "v0.289.0" }, "name": { + "description": "Name of the external location.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" }, "read_only": { + "description": "Indicates whether the external location is read-only.", "$ref": "#/$defs/bool", "x-since-version": "v0.289.0" }, "skip_validation": { + "description": "Skips validation of the storage credential associated with the external location.", "$ref": "#/$defs/bool", "x-since-version": "v0.289.0" }, "url": { + "description": "Path URL of the external location.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" } @@ -842,6 +865,7 @@ "x-since-version": "v0.229.0" }, "health": { + "description": "An optional set of health rules that can be defined for this job.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules", "x-since-version": "v0.229.0" }, @@ -890,6 +914,7 @@ "x-since-version": "v0.229.0" }, "run_as": { + "description": "The user or service principal that the job runs as, if specified in the request.\nThis field indicates the explicit configuration of `run_as` for the job.\nTo find the value in all cases, explicit or implicit, use `run_as_user_name`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs", "x-since-version": "v0.229.0" }, @@ -1324,7 +1349,7 @@ "x-since-version": "v0.229.0" }, "parameters": { - "description": "[Beta]", + "description": "[Beta] Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", "$ref": "#/$defs/map/string", "x-since-version": "v1.2.0" }, @@ -1350,6 +1375,7 @@ "x-since-version": "v0.253.0" }, "run_as": { + "description": "Write-only setting, available only in Create/Update calls. Specifies the user or service principal that the pipeline runs as. If not specified, the pipeline runs as the user who created the pipeline.\n\nOnly `user_name` or `service_principal_name` can be specified. If both are specified, an error is thrown.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RunAs", "x-since-version": "v0.241.0" }, @@ -1838,10 +1864,12 @@ "type": "object", "properties": { "aliases": { + "description": "List of aliases associated with the registered model", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RegisteredModelAlias", "x-since-version": "v0.273.0" }, "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", "$ref": "#/$defs/bool", "x-since-version": "v0.273.0" }, @@ -1856,14 +1884,17 @@ "x-since-version": "v0.229.0" }, "created_at": { + "description": "Creation timestamp of the registered model in milliseconds since the Unix epoch", "$ref": "#/$defs/int64", "x-since-version": "v0.273.0" }, "created_by": { + "description": "The identifier of the user who created the registered model", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "full_name": { + "description": "The three-level (fully qualified) name of the registered model", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, @@ -1877,6 +1908,7 @@ "x-since-version": "v0.268.0" }, "metastore_id": { + "description": "The unique identifier of the metastore", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, @@ -1886,6 +1918,7 @@ "x-since-version": "v0.229.0" }, "owner": { + "description": "The identifier of the user who owns the registered model", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, @@ -1900,10 +1933,12 @@ "x-since-version": "v0.229.0" }, "updated_at": { + "description": "Last-update timestamp of the registered model in milliseconds since the Unix epoch", "$ref": "#/$defs/int64", "x-since-version": "v0.273.0" }, "updated_by": { + "description": "The identifier of the user who updated the registered model last time", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" } @@ -1939,6 +1974,7 @@ "x-since-version": "v0.229.0" }, "properties": { + "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string", "x-since-version": "v0.229.0" }, @@ -2092,6 +2128,7 @@ "x-since-version": "v0.260.0" }, "spot_instance_policy": { + "description": "Configurations whether the endpoint should use spot instances.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SpotInstancePolicy", "x-since-version": "v0.260.0" }, @@ -2101,6 +2138,7 @@ "x-since-version": "v0.260.0" }, "warehouse_type": { + "description": "Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,\nyou must set to `PRO` and also set the field `enable_serverless_compute` to `true`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CreateWarehouseRequestWarehouseType", "x-since-version": "v0.260.0" } @@ -2136,7 +2174,7 @@ "type": "object", "properties": { "database_instance_name": { - "description": "[Public Preview]", + "description": "[Public Preview] Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, @@ -2145,17 +2183,17 @@ "x-since-version": "v0.268.0" }, "logical_database_name": { - "description": "[Public Preview]", + "description": "[Public Preview] Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the `create_database_objects_is_missing` field in `spec`.", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "name": { - "description": "[Public Preview]", + "description": "[Public Preview] Full three-part (catalog, schema, table) name of the table.", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "spec": { - "description": "[Public Preview]", + "description": "[Public Preview] Specification of a synced database table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec", "x-since-version": "v0.266.0" } @@ -2169,11 +2207,12 @@ "type": "object", "properties": { "budget_policy_id": { - "description": "[Public Preview]", + "description": "[Public Preview] The budget policy id to be applied", "$ref": "#/$defs/string", "x-since-version": "v0.298.0" }, "endpoint_type": { + "description": "Type of endpoint", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType", "x-since-version": "v0.298.0" }, @@ -2182,6 +2221,7 @@ "x-since-version": "v0.298.0" }, "name": { + "description": "Name of the AI Search endpoint", "$ref": "#/$defs/string", "x-since-version": "v0.298.0" }, @@ -2190,12 +2230,12 @@ "x-since-version": "v0.298.0" }, "target_qps": { - "description": "[Public Preview]", + "description": "[Public Preview] Target QPS for the endpoint. Mutually exclusive with num_replicas.\nThe actual replica count is calculated at index creation/sync time based on this value.\nBest-effort target; the system does not guarantee this QPS will be achieved.", "$ref": "#/$defs/int64", "x-since-version": "v0.299.2" }, "usage_policy_id": { - "description": "[Private Preview]", + "description": "[Private Preview] The usage policy id to be applied once we've migrated to usage policies", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -2212,14 +2252,17 @@ "type": "object", "properties": { "delta_sync_index_spec": { + "description": "Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.DeltaSyncVectorIndexSpecRequest", "x-since-version": "v1.1.0" }, "direct_access_index_spec": { + "description": "Specification for Direct Vector Access Index. Required if `index_type` is `DIRECT_ACCESS`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.DirectAccessVectorIndexSpec", "x-since-version": "v1.1.0" }, "endpoint_name": { + "description": "Name of the endpoint to be used for serving the index", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" }, @@ -2228,11 +2271,12 @@ "x-since-version": "v1.1.0" }, "index_subtype": { - "description": "[Beta]", + "description": "[Beta] The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype", "x-since-version": "v1.1.0" }, "index_type": { + "description": "There are 2 types of AI Search indexes:\n- `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.\n- `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType", "x-since-version": "v1.1.0" }, @@ -2241,10 +2285,12 @@ "x-since-version": "v1.1.0" }, "name": { + "description": "Name of the index", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" }, "primary_key": { + "description": "Primary key of the index", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" } @@ -2295,6 +2341,7 @@ "x-since-version": "v0.236.0" }, "volume_type": { + "description": "The type of the volume. An external volume is located in the specified external location.\nA managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.\n[Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.VolumeType", "x-since-version": "v0.236.0" } @@ -3114,6 +3161,7 @@ "x-since-version": "v0.283.0" }, "deployment_id": { + "description": "The unique id of the deployment.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, @@ -3128,10 +3176,12 @@ "x-since-version": "v0.283.0" }, "mode": { + "description": "The mode of which the deployment will manage the source code.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentMode", "x-since-version": "v0.239.0" }, "source_code_path": { + "description": "The workspace file system path of the source code used to create the app deployment. This is different from\n`deployment_artifacts.source_code_path`, which is the path used by the deployed app. The former refers\nto the original source code location of the app in the workspace during deployment creation, whereas\nthe latter provides a system generated stable snapshotted source code path used by the deployment.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" } @@ -3142,6 +3192,7 @@ "type": "object", "properties": { "source_code_path": { + "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" } @@ -3346,10 +3397,12 @@ "type": "object", "properties": { "id": { + "description": "Id of the job to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, "permission": { + "description": "Permissions to grant on the Job. Supported permissions are: \"CAN_MANAGE\", \"IS_OWNER\", \"CAN_MANAGE_RUN\", \"CAN_VIEW\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJobJobPermission", "x-since-version": "v0.239.0" } @@ -3397,14 +3450,17 @@ "type": "object", "properties": { "key": { + "description": "Key of the secret to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, "permission": { + "description": "Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: \"READ\", \"WRITE\", \"MANAGE\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecretSecretPermission", "x-since-version": "v0.239.0" }, "scope": { + "description": "Scope of the secret to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" } @@ -3429,10 +3485,12 @@ "type": "object", "properties": { "name": { + "description": "Name of the serving endpoint to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, "permission": { + "description": "Permission to grant on the serving endpoint. Supported permissions are: \"CAN_MANAGE\", \"CAN_QUERY\", \"CAN_VIEW\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpointServingEndpointPermission", "x-since-version": "v0.239.0" } @@ -3455,10 +3513,12 @@ "type": "object", "properties": { "id": { + "description": "Id of the SQL warehouse to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, "permission": { + "description": "Permission to grant on the SQL warehouse. Supported permissions are: \"CAN_MANAGE\", \"CAN_USE\", \"IS_OWNER\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouseSqlWarehousePermission", "x-since-version": "v0.239.0" } @@ -3668,6 +3728,7 @@ "type": "object", "properties": { "queue_url": { + "description": "The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}.\nOnly required for provided_sqs.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" } @@ -3699,14 +3760,17 @@ "type": "object", "properties": { "queue_url": { + "description": "The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name}\nOnly required for provided_aqs.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" }, "resource_group": { + "description": "Optional resource group for the queue, event grid subscription, and external location storage\naccount.\nOnly required for locations with a service principal storage credential", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" }, "subscription_id": { + "description": "Optional subscription id for the queue, event grid subscription, and external location storage\naccount.\nRequired for locations with a service principal storage credential", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" } @@ -3718,6 +3782,7 @@ "description": "Encryption options that apply to clients connecting to cloud storage.", "properties": { "sse_encryption_details": { + "description": "Server-Side Encryption properties for clients communicating with AWS s3.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.SseEncryptionDetails", "x-since-version": "v0.289.0" } @@ -3780,6 +3845,7 @@ "type": "object", "properties": { "subscription_name": { + "description": "The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}.\nOnly required for provided_pubsub.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" } @@ -4072,18 +4138,22 @@ "x-since-version": "v0.273.0" }, "catalog_name": { + "description": "The name of the catalog containing the model version", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "id": { + "description": "The unique identifier of the alias", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "model_name": { + "description": "The name of the parent registered model of the model version, relative to parent schema", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "schema_name": { + "description": "The name of the schema containing the model version, relative to parent catalog", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, @@ -4100,10 +4170,12 @@ "description": "Server-Side Encryption properties for clients communicating with AWS s3.", "properties": { "algorithm": { + "description": "Sets the value of the 'x-amz-server-side-encryption' header in S3 request.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.SseEncryptionDetailsAlgorithm", "x-since-version": "v0.289.0" }, "aws_kms_key_arn": { + "description": "Optional. The ARN of the SSE-KMS key used with the S3 location, when algorithm = \"SSE-KMS\".\nSets the value of the 'x-amz-server-side-encryption-aws-kms-key-id' header.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" } @@ -4163,6 +4235,7 @@ "description": "Attributes set during cluster creation which are related to Amazon Web Services.", "properties": { "availability": { + "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\n\nNote: If `first_on_demand` is zero, this availability type will be used for the entire cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAvailability", "x-since-version": "v0.229.0" }, @@ -4187,6 +4260,7 @@ "x-since-version": "v0.229.0" }, "ebs_volume_type": { + "description": "The type of EBS volumes that will be launched with this cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.EbsVolumeType", "x-since-version": "v0.229.0" }, @@ -4227,6 +4301,7 @@ "description": "Attributes set during cluster creation which are related to Microsoft Azure.", "properties": { "availability": { + "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\nNote: If `first_on_demand` is zero, this availability\ntype will be used for the entire cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAvailability", "x-since-version": "v0.229.0" }, @@ -4349,10 +4424,12 @@ "x-since-version": "v0.229.0" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", "x-since-version": "v0.229.0" }, "docker_image": { + "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", "x-since-version": "v0.229.0" }, @@ -4402,6 +4479,7 @@ "x-since-version": "v0.237.0" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind", "x-since-version": "v0.237.0" }, @@ -4426,6 +4504,7 @@ "x-since-version": "v0.257.0" }, "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine", "x-since-version": "v0.229.0" }, @@ -4470,6 +4549,7 @@ "x-since-version": "v0.285.0" }, "workload_type": { + "description": "Cluster Attributes showing for clusters workload types.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType", "x-since-version": "v0.229.0" } @@ -4551,6 +4631,7 @@ "type": "object", "properties": { "basic_auth": { + "description": "Basic auth with username and password", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerBasicAuth", "x-since-version": "v0.229.0" }, @@ -4597,7 +4678,7 @@ "x-since-version": "v0.252.0" }, "java_dependencies": { - "description": "[Public Preview]", + "description": "[Public Preview] List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.271.0" } @@ -4609,6 +4690,7 @@ "description": "Attributes set during cluster creation which are related to GCP.", "properties": { "availability": { + "description": "This field determines whether the spark executors will be scheduled to run on preemptible\nVMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability", "x-since-version": "v0.229.0" }, @@ -5514,6 +5596,7 @@ "description": "Configures the Lakeview Dashboard job task type.", "properties": { "dashboard_id": { + "description": "The identifier of the dashboard to refresh.", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, @@ -5525,6 +5608,7 @@ "x-since-version": "v0.289.0" }, "subscription": { + "description": "Optional: subscription configuration for sending the dashboard snapshot.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Subscription", "x-since-version": "v0.248.0" }, @@ -5917,6 +6001,7 @@ "x-since-version": "v0.229.0" }, "spec": { + "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip and java dependencies are supported.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Environment", "x-since-version": "v0.229.0" } @@ -6069,10 +6154,12 @@ "type": "object", "properties": { "metric": { + "description": "Specifies the health metric that is being evaluated for a particular health rule.\n\n* `RUN_DURATION_SECONDS`: Expected total time for a run in seconds.\n* `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric", "x-since-version": "v0.229.0" }, "op": { + "description": "Specifies the operator used to compare the health metric value with the specified threshold.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthOperator", "x-since-version": "v0.229.0" }, @@ -6839,6 +6926,7 @@ "x-since-version": "v0.248.0" }, "subscribers": { + "description": "The list of subscribers to send the snapshot of the dashboard to.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionSubscriber", "x-since-version": "v0.248.0" } @@ -6849,10 +6937,12 @@ "type": "object", "properties": { "destination_id": { + "description": "A snapshot of the dashboard will be sent to the destination when the `destination_id` field is present.", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "user_name": { + "description": "A snapshot of the dashboard will be sent to the user's email when the `user_name` field is present.", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" } @@ -6985,6 +7075,7 @@ "x-since-version": "v0.243.0" }, "health": { + "description": "An optional set of health rules that can be defined for this job.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules", "x-since-version": "v0.229.0" }, @@ -7917,7 +8008,7 @@ "x-since-version": "v0.229.0" }, "netsuite_jar_path": { - "description": "[Private Preview]", + "description": "[Private Preview] Netsuite only configuration. When the field is set for a netsuite connector,\nthe jar stored in the field will be validated and added to the classpath of\npipeline's cluster.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -8978,7 +9069,7 @@ "x-since-version": "v0.231.0" }, "workday_report_parameters": { - "description": "[Private Preview]", + "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -10447,7 +10538,7 @@ "type": "object", "properties": { "aggregation": { - "description": "[Public Preview]", + "description": "[Public Preview] If not set, the behavior is equivalent to using `First row` in the UI.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation", "x-since-version": "v0.279.0" }, @@ -10664,26 +10755,32 @@ "x-since-version": "v1.1.0" }, "columns_to_sync": { + "description": "[Optional] Select the columns to sync with the vector index. If you leave this field blank, all columns\nfrom the source table are synced with the index. The primary key column and embedding source column or\nembedding vector column are always synced.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "embedding_source_columns": { + "description": "The columns that contain the embedding source.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", "x-since-version": "v1.1.0" }, "embedding_vector_columns": { + "description": "The columns that contain the embedding vectors.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", "x-since-version": "v1.1.0" }, "embedding_writeback_table": { + "description": "[Optional] Name of the Delta table to sync the vector index contents and computed embeddings to.", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" }, "pipeline_type": { + "description": "Pipeline execution mode.\n- `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.\n- `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.PipelineType", "x-since-version": "v1.1.0" }, "source_table": { + "description": "The name of the source table.", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" } @@ -10694,14 +10791,17 @@ "type": "object", "properties": { "embedding_source_columns": { + "description": "The columns that contain the embedding source. The format should be array[double].", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", "x-since-version": "v1.1.0" }, "embedding_vector_columns": { + "description": "The columns that contain the embedding vectors. The format should be array[double].", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", "x-since-version": "v1.1.0" }, "schema_json": { + "description": "The schema of the index in JSON format.\nSupported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.\nSupported types for vector column: `array\u003cfloat\u003e`, `array\u003cdouble\u003e`,`.", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" } @@ -10712,14 +10812,17 @@ "type": "object", "properties": { "embedding_model_endpoint_name": { + "description": "Name of the embedding model endpoint, used by default for both ingestion and querying.", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" }, "model_endpoint_name_for_query": { + "description": "Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" }, "name": { + "description": "Name of the column", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" } @@ -10730,10 +10833,12 @@ "type": "object", "properties": { "embedding_dimension": { + "description": "Dimension of the embedding vector", "$ref": "#/$defs/int", "x-since-version": "v1.1.0" }, "name": { + "description": "Name of the column", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" } diff --git a/python/databricks/bundles/catalogs/_models/catalog.py b/python/databricks/bundles/catalogs/_models/catalog.py index eb9aaf83750..1b35255dd6d 100644 --- a/python/databricks/bundles/catalogs/_models/catalog.py +++ b/python/databricks/bundles/catalogs/_models/catalog.py @@ -29,10 +29,19 @@ class Catalog(Resource): """""" name: VariableOr[str] + """ + Name of catalog. + """ comment: VariableOrOptional[str] = None + """ + User-provided free-form text description. + """ connection_name: VariableOrOptional[str] = None + """ + The name of the connection to an external data source. + """ grants: VariableOrList[PrivilegeAssignment] = field(default_factory=list) @@ -44,14 +53,31 @@ class Catalog(Resource): """ options: VariableOrDict[str] = field(default_factory=dict) + """ + A map of key-value properties attached to the securable. + """ properties: VariableOrDict[str] = field(default_factory=dict) + """ + A map of key-value properties attached to the securable. + """ provider_name: VariableOrOptional[str] = None + """ + The name of delta sharing provider. + + A Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server. + """ share_name: VariableOrOptional[str] = None + """ + The name of the share under the share provider. + """ storage_root: VariableOrOptional[str] = None + """ + Storage root URL for managed tables within catalog. + """ @classmethod def from_dict(cls, value: "CatalogDict") -> "Self": @@ -65,10 +91,19 @@ class CatalogDict(TypedDict, total=False): """""" name: VariableOr[str] + """ + Name of catalog. + """ comment: VariableOrOptional[str] + """ + User-provided free-form text description. + """ connection_name: VariableOrOptional[str] + """ + The name of the connection to an external data source. + """ grants: VariableOrList[PrivilegeAssignmentParam] @@ -80,14 +115,31 @@ class CatalogDict(TypedDict, total=False): """ options: VariableOrDict[str] + """ + A map of key-value properties attached to the securable. + """ properties: VariableOrDict[str] + """ + A map of key-value properties attached to the securable. + """ provider_name: VariableOrOptional[str] + """ + The name of delta sharing provider. + + A Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server. + """ share_name: VariableOrOptional[str] + """ + The name of the share under the share provider. + """ storage_root: VariableOrOptional[str] + """ + Storage root URL for managed tables within catalog. + """ CatalogParam = CatalogDict | Catalog diff --git a/python/databricks/bundles/jobs/_models/aws_attributes.py b/python/databricks/bundles/jobs/_models/aws_attributes.py index 62ddf7a7653..64aa3ab01c0 100644 --- a/python/databricks/bundles/jobs/_models/aws_attributes.py +++ b/python/databricks/bundles/jobs/_models/aws_attributes.py @@ -24,6 +24,11 @@ class AwsAttributes: """ availability: VariableOrOptional[AwsAvailability] = None + """ + Availability type used for all subsequent nodes past the `first_on_demand` ones. + + Note: If `first_on_demand` is zero, this availability type will be used for the entire cluster. + """ ebs_volume_count: VariableOrOptional[int] = None """ @@ -63,6 +68,9 @@ class AwsAttributes: """ ebs_volume_type: VariableOrOptional[EbsVolumeType] = None + """ + The type of EBS volumes that will be launched with this cluster. + """ first_on_demand: VariableOrOptional[int] = None """ @@ -124,6 +132,11 @@ class AwsAttributesDict(TypedDict, total=False): """""" availability: VariableOrOptional[AwsAvailabilityParam] + """ + Availability type used for all subsequent nodes past the `first_on_demand` ones. + + Note: If `first_on_demand` is zero, this availability type will be used for the entire cluster. + """ ebs_volume_count: VariableOrOptional[int] """ @@ -163,6 +176,9 @@ class AwsAttributesDict(TypedDict, total=False): """ ebs_volume_type: VariableOrOptional[EbsVolumeTypeParam] + """ + The type of EBS volumes that will be launched with this cluster. + """ first_on_demand: VariableOrOptional[int] """ diff --git a/python/databricks/bundles/jobs/_models/azure_attributes.py b/python/databricks/bundles/jobs/_models/azure_attributes.py index f82a0698aa6..0e1c2379025 100644 --- a/python/databricks/bundles/jobs/_models/azure_attributes.py +++ b/python/databricks/bundles/jobs/_models/azure_attributes.py @@ -24,6 +24,11 @@ class AzureAttributes: """ availability: VariableOrOptional[AzureAvailability] = None + """ + Availability type used for all subsequent nodes past the `first_on_demand` ones. + Note: If `first_on_demand` is zero, this availability + type will be used for the entire cluster. + """ first_on_demand: VariableOrOptional[int] = None """ @@ -61,6 +66,11 @@ class AzureAttributesDict(TypedDict, total=False): """""" availability: VariableOrOptional[AzureAvailabilityParam] + """ + Availability type used for all subsequent nodes past the `first_on_demand` ones. + Note: If `first_on_demand` is zero, this availability + type will be used for the entire cluster. + """ first_on_demand: VariableOrOptional[int] """ diff --git a/python/databricks/bundles/jobs/_models/cluster_spec.py b/python/databricks/bundles/jobs/_models/cluster_spec.py index a2662c5ca85..bd0da1c0091 100644 --- a/python/databricks/bundles/jobs/_models/cluster_spec.py +++ b/python/databricks/bundles/jobs/_models/cluster_spec.py @@ -119,8 +119,32 @@ class ClusterSpec: """ data_security_mode: VariableOrOptional[DataSecurityMode] = None + """ + Data security mode decides what data governance model to use when accessing data + from a cluster. + + * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration. + * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + * `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. + + The following modes are legacy aliases for the above modes: + + * `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. + * `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. + + The following modes are deprecated starting with Databricks Runtime 15.0 and + will be removed for future Databricks Runtime versions: + + * `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. + * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters. + * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters. + * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled. + """ docker_image: VariableOrOptional[DockerImage] = None + """ + Custom docker image BYOC + """ driver_instance_pool_id: VariableOrOptional[str] = None """ @@ -181,6 +205,17 @@ class ClusterSpec: """ kind: VariableOrOptional[Kind] = None + """ + The kind of compute described by this compute specification. + + Depending on `kind`, different validations and default values will be applied. + + Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not. + * [is_single_node](/api/workspace/clusters/create#is_single_node) + * [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) + + By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. + """ node_type_id: VariableOrOptional[str] = None """ @@ -213,6 +248,15 @@ class ClusterSpec: """ runtime_engine: VariableOrOptional[RuntimeEngine] = None + """ + Determines the cluster's runtime engine, either standard or Photon. + + This field is not compatible with legacy `spark_version` values that contain `-photon-`. + Remove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`. + + If left unspecified, the runtime engine defaults to standard unless the spark_version + contains -photon-, in which case Photon will be used. + """ single_user_name: VariableOrOptional[str] = None """ @@ -273,6 +317,9 @@ class ClusterSpec: """ workload_type: VariableOrOptional[WorkloadType] = None + """ + Cluster Attributes showing for clusters workload types. + """ @classmethod def from_dict(cls, value: "ClusterSpecDict") -> "Self": @@ -343,8 +390,32 @@ class ClusterSpecDict(TypedDict, total=False): """ data_security_mode: VariableOrOptional[DataSecurityModeParam] + """ + Data security mode decides what data governance model to use when accessing data + from a cluster. + + * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration. + * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + * `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. + + The following modes are legacy aliases for the above modes: + + * `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. + * `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. + + The following modes are deprecated starting with Databricks Runtime 15.0 and + will be removed for future Databricks Runtime versions: + + * `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. + * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters. + * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters. + * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled. + """ docker_image: VariableOrOptional[DockerImageParam] + """ + Custom docker image BYOC + """ driver_instance_pool_id: VariableOrOptional[str] """ @@ -405,6 +476,17 @@ class ClusterSpecDict(TypedDict, total=False): """ kind: VariableOrOptional[KindParam] + """ + The kind of compute described by this compute specification. + + Depending on `kind`, different validations and default values will be applied. + + Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not. + * [is_single_node](/api/workspace/clusters/create#is_single_node) + * [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) + + By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. + """ node_type_id: VariableOrOptional[str] """ @@ -437,6 +519,15 @@ class ClusterSpecDict(TypedDict, total=False): """ runtime_engine: VariableOrOptional[RuntimeEngineParam] + """ + Determines the cluster's runtime engine, either standard or Photon. + + This field is not compatible with legacy `spark_version` values that contain `-photon-`. + Remove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`. + + If left unspecified, the runtime engine defaults to standard unless the spark_version + contains -photon-, in which case Photon will be used. + """ single_user_name: VariableOrOptional[str] """ @@ -497,6 +588,9 @@ class ClusterSpecDict(TypedDict, total=False): """ workload_type: VariableOrOptional[WorkloadTypeParam] + """ + Cluster Attributes showing for clusters workload types. + """ ClusterSpecParam = ClusterSpecDict | ClusterSpec diff --git a/python/databricks/bundles/jobs/_models/dashboard_task.py b/python/databricks/bundles/jobs/_models/dashboard_task.py index c38c14f83df..4fb86a325ca 100644 --- a/python/databricks/bundles/jobs/_models/dashboard_task.py +++ b/python/databricks/bundles/jobs/_models/dashboard_task.py @@ -17,6 +17,9 @@ class DashboardTask: """ dashboard_id: VariableOrOptional[str] = None + """ + The identifier of the dashboard to refresh. + """ filters: VariableOrDict[str] = field(default_factory=dict) """ @@ -31,6 +34,9 @@ class DashboardTask: """ subscription: VariableOrOptional[Subscription] = None + """ + Optional: subscription configuration for sending the dashboard snapshot. + """ warehouse_id: VariableOrOptional[str] = None """ @@ -50,6 +56,9 @@ class DashboardTaskDict(TypedDict, total=False): """""" dashboard_id: VariableOrOptional[str] + """ + The identifier of the dashboard to refresh. + """ filters: VariableOrDict[str] """ @@ -64,6 +73,9 @@ class DashboardTaskDict(TypedDict, total=False): """ subscription: VariableOrOptional[SubscriptionParam] + """ + Optional: subscription configuration for sending the dashboard snapshot. + """ warehouse_id: VariableOrOptional[str] """ diff --git a/python/databricks/bundles/jobs/_models/docker_image.py b/python/databricks/bundles/jobs/_models/docker_image.py index 3a76b2bbf38..bce0a359893 100644 --- a/python/databricks/bundles/jobs/_models/docker_image.py +++ b/python/databricks/bundles/jobs/_models/docker_image.py @@ -18,6 +18,9 @@ class DockerImage: """""" basic_auth: VariableOrOptional[DockerBasicAuth] = None + """ + Basic auth with username and password + """ url: VariableOrOptional[str] = None """ @@ -36,6 +39,9 @@ class DockerImageDict(TypedDict, total=False): """""" basic_auth: VariableOrOptional[DockerBasicAuthParam] + """ + Basic auth with username and password + """ url: VariableOrOptional[str] """ diff --git a/python/databricks/bundles/jobs/_models/environment.py b/python/databricks/bundles/jobs/_models/environment.py index 98b8e209434..35ae5e747ed 100644 --- a/python/databricks/bundles/jobs/_models/environment.py +++ b/python/databricks/bundles/jobs/_models/environment.py @@ -48,7 +48,7 @@ class Environment: java_dependencies: VariableOrList[str] = field(default_factory=list) """ - [Public Preview] + [Public Preview] List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`. """ @classmethod @@ -94,7 +94,7 @@ class EnvironmentDict(TypedDict, total=False): java_dependencies: VariableOrList[str] """ - [Public Preview] + [Public Preview] List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`. """ diff --git a/python/databricks/bundles/jobs/_models/gcp_attributes.py b/python/databricks/bundles/jobs/_models/gcp_attributes.py index e87ff1ab37c..c89d9d31b13 100644 --- a/python/databricks/bundles/jobs/_models/gcp_attributes.py +++ b/python/databricks/bundles/jobs/_models/gcp_attributes.py @@ -24,6 +24,10 @@ class GcpAttributes: """ availability: VariableOrOptional[GcpAvailability] = None + """ + This field determines whether the spark executors will be scheduled to run on preemptible + VMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable. + """ boot_disk_size: VariableOrOptional[int] = None """ @@ -95,6 +99,10 @@ class GcpAttributesDict(TypedDict, total=False): """""" availability: VariableOrOptional[GcpAvailabilityParam] + """ + This field determines whether the spark executors will be scheduled to run on preemptible + VMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable. + """ boot_disk_size: VariableOrOptional[int] """ diff --git a/python/databricks/bundles/jobs/_models/job.py b/python/databricks/bundles/jobs/_models/job.py index d75cd7b1200..1fa13e5bb04 100644 --- a/python/databricks/bundles/jobs/_models/job.py +++ b/python/databricks/bundles/jobs/_models/job.py @@ -110,6 +110,9 @@ class Job(Resource): """ health: VariableOrOptional[JobsHealthRules] = None + """ + An optional set of health rules that can be defined for this job. + """ job_clusters: VariableOrList[JobCluster] = field(default_factory=list) """ @@ -163,6 +166,11 @@ class Job(Resource): """ run_as: VariableOrOptional[JobRunAs] = None + """ + The user or service principal that the job runs as, if specified in the request. + This field indicates the explicit configuration of `run_as` for the job. + To find the value in all cases, explicit or implicit, use `run_as_user_name`. + """ schedule: VariableOrOptional[CronSchedule] = None """ @@ -255,6 +263,9 @@ class JobDict(TypedDict, total=False): """ health: VariableOrOptional[JobsHealthRulesParam] + """ + An optional set of health rules that can be defined for this job. + """ job_clusters: VariableOrList[JobClusterParam] """ @@ -308,6 +319,11 @@ class JobDict(TypedDict, total=False): """ run_as: VariableOrOptional[JobRunAsParam] + """ + The user or service principal that the job runs as, if specified in the request. + This field indicates the explicit configuration of `run_as` for the job. + To find the value in all cases, explicit or implicit, use `run_as_user_name`. + """ schedule: VariableOrOptional[CronScheduleParam] """ diff --git a/python/databricks/bundles/jobs/_models/job_environment.py b/python/databricks/bundles/jobs/_models/job_environment.py index 798685f4c68..ee3769d00f1 100644 --- a/python/databricks/bundles/jobs/_models/job_environment.py +++ b/python/databricks/bundles/jobs/_models/job_environment.py @@ -20,6 +20,10 @@ class JobEnvironment: """ spec: VariableOrOptional[Environment] = None + """ + The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines. + In this minimal environment spec, only pip and java dependencies are supported. + """ @classmethod def from_dict(cls, value: "JobEnvironmentDict") -> "Self": @@ -38,6 +42,10 @@ class JobEnvironmentDict(TypedDict, total=False): """ spec: VariableOrOptional[EnvironmentParam] + """ + The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines. + In this minimal environment spec, only pip and java dependencies are supported. + """ JobEnvironmentParam = JobEnvironmentDict | JobEnvironment diff --git a/python/databricks/bundles/jobs/_models/jobs_health_rule.py b/python/databricks/bundles/jobs/_models/jobs_health_rule.py index 149265c86a9..0be82576ea2 100644 --- a/python/databricks/bundles/jobs/_models/jobs_health_rule.py +++ b/python/databricks/bundles/jobs/_models/jobs_health_rule.py @@ -22,8 +22,20 @@ class JobsHealthRule: """""" metric: VariableOr[JobsHealthMetric] + """ + Specifies the health metric that is being evaluated for a particular health rule. + + * `RUN_DURATION_SECONDS`: Expected total time for a run in seconds. + * `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview. + * `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all streams. This metric is in Public Preview. + * `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview. + * `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview. + """ op: VariableOr[JobsHealthOperator] + """ + Specifies the operator used to compare the health metric value with the specified threshold. + """ value: VariableOr[int] """ @@ -42,8 +54,20 @@ class JobsHealthRuleDict(TypedDict, total=False): """""" metric: VariableOr[JobsHealthMetricParam] + """ + Specifies the health metric that is being evaluated for a particular health rule. + + * `RUN_DURATION_SECONDS`: Expected total time for a run in seconds. + * `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview. + * `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all streams. This metric is in Public Preview. + * `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview. + * `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview. + """ op: VariableOr[JobsHealthOperatorParam] + """ + Specifies the operator used to compare the health metric value with the specified threshold. + """ value: VariableOr[int] """ diff --git a/python/databricks/bundles/jobs/_models/subscription.py b/python/databricks/bundles/jobs/_models/subscription.py index 2d639902450..5636e02d312 100644 --- a/python/databricks/bundles/jobs/_models/subscription.py +++ b/python/databricks/bundles/jobs/_models/subscription.py @@ -29,6 +29,9 @@ class Subscription: """ subscribers: VariableOrList[SubscriptionSubscriber] = field(default_factory=list) + """ + The list of subscribers to send the snapshot of the dashboard to. + """ @classmethod def from_dict(cls, value: "SubscriptionDict") -> "Self": @@ -53,6 +56,9 @@ class SubscriptionDict(TypedDict, total=False): """ subscribers: VariableOrList[SubscriptionSubscriberParam] + """ + The list of subscribers to send the snapshot of the dashboard to. + """ SubscriptionParam = SubscriptionDict | Subscription diff --git a/python/databricks/bundles/jobs/_models/subscription_subscriber.py b/python/databricks/bundles/jobs/_models/subscription_subscriber.py index eddc8fc7aaf..bb45559505b 100644 --- a/python/databricks/bundles/jobs/_models/subscription_subscriber.py +++ b/python/databricks/bundles/jobs/_models/subscription_subscriber.py @@ -14,8 +14,14 @@ class SubscriptionSubscriber: """""" destination_id: VariableOrOptional[str] = None + """ + A snapshot of the dashboard will be sent to the destination when the `destination_id` field is present. + """ user_name: VariableOrOptional[str] = None + """ + A snapshot of the dashboard will be sent to the user's email when the `user_name` field is present. + """ @classmethod def from_dict(cls, value: "SubscriptionSubscriberDict") -> "Self": @@ -29,8 +35,14 @@ class SubscriptionSubscriberDict(TypedDict, total=False): """""" destination_id: VariableOrOptional[str] + """ + A snapshot of the dashboard will be sent to the destination when the `destination_id` field is present. + """ user_name: VariableOrOptional[str] + """ + A snapshot of the dashboard will be sent to the user's email when the `user_name` field is present. + """ SubscriptionSubscriberParam = SubscriptionSubscriberDict | SubscriptionSubscriber diff --git a/python/databricks/bundles/jobs/_models/task.py b/python/databricks/bundles/jobs/_models/task.py index 19f12c8a993..06c7043b003 100644 --- a/python/databricks/bundles/jobs/_models/task.py +++ b/python/databricks/bundles/jobs/_models/task.py @@ -200,6 +200,9 @@ class Task: """ health: VariableOrOptional[JobsHealthRules] = None + """ + An optional set of health rules that can be defined for this job. + """ job_cluster_key: VariableOrOptional[str] = None """ @@ -422,6 +425,9 @@ class TaskDict(TypedDict, total=False): """ health: VariableOrOptional[JobsHealthRulesParam] + """ + An optional set of health rules that can be defined for this job. + """ job_cluster_key: VariableOrOptional[str] """ diff --git a/python/databricks/bundles/pipelines/_models/aws_attributes.py b/python/databricks/bundles/pipelines/_models/aws_attributes.py index 47bc0b97ce1..96d999815de 100644 --- a/python/databricks/bundles/pipelines/_models/aws_attributes.py +++ b/python/databricks/bundles/pipelines/_models/aws_attributes.py @@ -24,6 +24,11 @@ class AwsAttributes: """ availability: VariableOrOptional[AwsAvailability] = None + """ + Availability type used for all subsequent nodes past the `first_on_demand` ones. + + Note: If `first_on_demand` is zero, this availability type will be used for the entire cluster. + """ ebs_volume_count: VariableOrOptional[int] = None """ @@ -63,6 +68,9 @@ class AwsAttributes: """ ebs_volume_type: VariableOrOptional[EbsVolumeType] = None + """ + The type of EBS volumes that will be launched with this cluster. + """ first_on_demand: VariableOrOptional[int] = None """ @@ -124,6 +132,11 @@ class AwsAttributesDict(TypedDict, total=False): """""" availability: VariableOrOptional[AwsAvailabilityParam] + """ + Availability type used for all subsequent nodes past the `first_on_demand` ones. + + Note: If `first_on_demand` is zero, this availability type will be used for the entire cluster. + """ ebs_volume_count: VariableOrOptional[int] """ @@ -163,6 +176,9 @@ class AwsAttributesDict(TypedDict, total=False): """ ebs_volume_type: VariableOrOptional[EbsVolumeTypeParam] + """ + The type of EBS volumes that will be launched with this cluster. + """ first_on_demand: VariableOrOptional[int] """ diff --git a/python/databricks/bundles/pipelines/_models/azure_attributes.py b/python/databricks/bundles/pipelines/_models/azure_attributes.py index f06f84e9c9f..42a481b1938 100644 --- a/python/databricks/bundles/pipelines/_models/azure_attributes.py +++ b/python/databricks/bundles/pipelines/_models/azure_attributes.py @@ -24,6 +24,11 @@ class AzureAttributes: """ availability: VariableOrOptional[AzureAvailability] = None + """ + Availability type used for all subsequent nodes past the `first_on_demand` ones. + Note: If `first_on_demand` is zero, this availability + type will be used for the entire cluster. + """ first_on_demand: VariableOrOptional[int] = None """ @@ -61,6 +66,11 @@ class AzureAttributesDict(TypedDict, total=False): """""" availability: VariableOrOptional[AzureAvailabilityParam] + """ + Availability type used for all subsequent nodes past the `first_on_demand` ones. + Note: If `first_on_demand` is zero, this availability + type will be used for the entire cluster. + """ first_on_demand: VariableOrOptional[int] """ diff --git a/python/databricks/bundles/pipelines/_models/gcp_attributes.py b/python/databricks/bundles/pipelines/_models/gcp_attributes.py index 7ae9b24d4d5..be4ef269052 100644 --- a/python/databricks/bundles/pipelines/_models/gcp_attributes.py +++ b/python/databricks/bundles/pipelines/_models/gcp_attributes.py @@ -24,6 +24,10 @@ class GcpAttributes: """ availability: VariableOrOptional[GcpAvailability] = None + """ + This field determines whether the spark executors will be scheduled to run on preemptible + VMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable. + """ boot_disk_size: VariableOrOptional[int] = None """ @@ -95,6 +99,10 @@ class GcpAttributesDict(TypedDict, total=False): """""" availability: VariableOrOptional[GcpAvailabilityParam] + """ + This field determines whether the spark executors will be scheduled to run on preemptible + VMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable. + """ boot_disk_size: VariableOrOptional[int] """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py index 20e1cfe78ca..8263ae64b77 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py @@ -87,7 +87,9 @@ class IngestionPipelineDefinition: """ :meta private: [EXPERIMENTAL] - [Private Preview] + [Private Preview] Netsuite only configuration. When the field is set for a netsuite connector, + the jar stored in the field will be validated and added to the classpath of + pipeline's cluster. """ objects: VariableOrList[IngestionConfig] = field(default_factory=list) @@ -166,7 +168,9 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] + [Private Preview] Netsuite only configuration. When the field is set for a netsuite connector, + the jar stored in the field will be validated and added to the classpath of + pipeline's cluster. """ objects: VariableOrList[IngestionConfigParam] diff --git a/python/databricks/bundles/pipelines/_models/pipeline.py b/python/databricks/bundles/pipelines/_models/pipeline.py index 5d23141c42f..05a6435969a 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline.py +++ b/python/databricks/bundles/pipelines/_models/pipeline.py @@ -159,7 +159,8 @@ class Pipeline(Resource): parameters: VariableOrDict[str] = field(default_factory=dict) """ - [Beta] + [Beta] Key/value map of default parameters to use for pipeline execution. + Maximum total size: 10k characters (JSON format) """ permissions: VariableOrList[PipelinePermission] = field(default_factory=list) @@ -184,6 +185,11 @@ class Pipeline(Resource): """ run_as: VariableOrOptional[RunAs] = None + """ + Write-only setting, available only in Create/Update calls. Specifies the user or service principal that the pipeline runs as. If not specified, the pipeline runs as the user who created the pipeline. + + Only `user_name` or `service_principal_name` can be specified. If both are specified, an error is thrown. + """ schema: VariableOrOptional[str] = None """ @@ -329,7 +335,8 @@ class PipelineDict(TypedDict, total=False): parameters: VariableOrDict[str] """ - [Beta] + [Beta] Key/value map of default parameters to use for pipeline execution. + Maximum total size: 10k characters (JSON format) """ permissions: VariableOrList[PipelinePermissionParam] @@ -354,6 +361,11 @@ class PipelineDict(TypedDict, total=False): """ run_as: VariableOrOptional[RunAsParam] + """ + Write-only setting, available only in Create/Update calls. Specifies the user or service principal that the pipeline runs as. If not specified, the pipeline runs as the user who created the pipeline. + + Only `user_name` or `service_principal_name` can be specified. If both are specified, an error is thrown. + """ schema: VariableOrOptional[str] """ diff --git a/python/databricks/bundles/pipelines/_models/table_specific_config.py b/python/databricks/bundles/pipelines/_models/table_specific_config.py index 117869fe710..b1c4a9ba6e6 100644 --- a/python/databricks/bundles/pipelines/_models/table_specific_config.py +++ b/python/databricks/bundles/pipelines/_models/table_specific_config.py @@ -103,7 +103,7 @@ class TableSpecificConfig: """ :meta private: [EXPERIMENTAL] - [Private Preview] + [Private Preview] (Optional) Additional custom parameters for Workday Report """ @classmethod @@ -191,7 +191,7 @@ class TableSpecificConfigDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - [Private Preview] + [Private Preview] (Optional) Additional custom parameters for Workday Report """ diff --git a/python/databricks/bundles/schemas/_models/schema.py b/python/databricks/bundles/schemas/_models/schema.py index d12385e3953..5dfa24d41b4 100644 --- a/python/databricks/bundles/schemas/_models/schema.py +++ b/python/databricks/bundles/schemas/_models/schema.py @@ -47,6 +47,9 @@ class Schema(Resource): """ properties: VariableOrDict[str] = field(default_factory=dict) + """ + A map of key-value properties attached to the securable. + """ storage_root: VariableOrOptional[str] = None """ @@ -87,6 +90,9 @@ class SchemaDict(TypedDict, total=False): """ properties: VariableOrDict[str] + """ + A map of key-value properties attached to the securable. + """ storage_root: VariableOrOptional[str] """ diff --git a/python/databricks/bundles/volumes/_models/volume.py b/python/databricks/bundles/volumes/_models/volume.py index bf77c831d65..55c6e350163 100644 --- a/python/databricks/bundles/volumes/_models/volume.py +++ b/python/databricks/bundles/volumes/_models/volume.py @@ -57,6 +57,11 @@ class Volume(Resource): """ volume_type: VariableOrOptional[VolumeType] = None + """ + The type of the volume. An external volume is located in the specified external location. + A managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore. + [Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external) + """ @classmethod def from_dict(cls, value: "VolumeDict") -> "Self": @@ -102,6 +107,11 @@ class VolumeDict(TypedDict, total=False): """ volume_type: VariableOrOptional[VolumeTypeParam] + """ + The type of the volume. An external volume is located in the specified external location. + A managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore. + [Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external) + """ VolumeParam = VolumeDict | Volume