From a4951a2d04b0eda4c6be5dee22475010d52cb16b Mon Sep 17 00:00:00 2001 From: Shreyas Goenka Date: Fri, 19 Jun 2026 13:15:20 +0000 Subject: [PATCH] Stop keeping the docs schema on main; publish it only to docgen MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit bundle/schema/jsonschema_for_docs.json was a checked-in generated artifact on main, but nothing in the CLI reads it — the binary embeds jsonschema.json, and bundle/docsgen regenerates from Go types. Its only consumer is downstream docs tooling, which now reads the schema from the docgen branch. - Delete bundle/schema/jsonschema_for_docs.json and remove generate-schema-docs from the `all`/`generate` aggregators and the Taskfile, so `task generate` no longer recreates it on main. (generate-check, the CI drift subset, already excluded it.) - The update-schema-docs workflow now regenerates the schema straight into the docgen worktree and commits it there, instead of generating on main and copying. Drops the now-unneeded "assert only the docs schema changed on main" and capture steps. - Drop the file from .wsignore, .gitattributes, and the auto-generated-files rule. Co-authored-by: Isaac --- .agent/rules/auto-generated-files.md | 6 +- .github/workflows/update-schema-docs.yml | 46 +- .wsignore | 1 - Taskfile.yml | 27 +- bundle/schema/.gitattributes | 1 - bundle/schema/jsonschema_for_docs.json | 11809 --------------------- 6 files changed, 22 insertions(+), 11868 deletions(-) delete mode 100644 bundle/schema/jsonschema_for_docs.json diff --git a/.agent/rules/auto-generated-files.md b/.agent/rules/auto-generated-files.md index 92bd965d3be..0104602cf84 100644 --- a/.agent/rules/auto-generated-files.md +++ b/.agent/rules/auto-generated-files.md @@ -16,7 +16,6 @@ globs: - "bundle/direct/dresources/*.generated.yml" - "bundle/internal/validation/generated/*.go" - "bundle/schema/jsonschema.json" - - "bundle/schema/jsonschema_for_docs.json" - "python/databricks/bundles/version.py" - "python/databricks/bundles/*/__init__.py" - "python/databricks/bundles/*/_models/*.py" @@ -36,7 +35,6 @@ paths: - "bundle/direct/dresources/*.generated.yml" - "bundle/internal/validation/generated/*.go" - "bundle/schema/jsonschema.json" - - "bundle/schema/jsonschema_for_docs.json" - "python/databricks/bundles/version.py" - "python/databricks/bundles/*/__init__.py" - "python/databricks/bundles/*/_models/*.py" @@ -69,8 +67,8 @@ Files matching this rule's glob pattern are most likely generated artifacts. Aut - `./task generate-direct` (or `./task generate-direct-apitypes`, `./task generate-direct-resources`) - Bundle schemas: - `./task generate-schema` - - `./task generate-schema-docs` - - Both rewrite `bundle/internal/schema/annotations.yml` in place: upstream docs are sourced from `.codegen/cli.json` at generation time, and the file is synced with the config structure (placeholders added, stale entries dropped). + - Rewrites `bundle/internal/schema/annotations.yml` in place: upstream docs are sourced from `.codegen/cli.json` at generation time, and the file is synced with the config structure (placeholders added, stale entries dropped). + - The docs schema (`jsonschema_for_docs.json`) is not generated on main; it is built and published to the `docgen` branch on release by `.github/workflows/update-schema-docs.yml`. - Validation generated code: - `./task generate-validation` - Mock files: diff --git a/.github/workflows/update-schema-docs.yml b/.github/workflows/update-schema-docs.yml index f47e191e49a..a3e67fff28b 100644 --- a/.github/workflows/update-schema-docs.yml +++ b/.github/workflows/update-schema-docs.yml @@ -1,7 +1,8 @@ name: update-schema-docs -# Regenerate bundle/schema/jsonschema_for_docs.json after every release and -# publish it to the `docgen` branch. +# Regenerate the bundle docs JSON schema after every release and publish it to +# the `docgen` branch. The docs schema is NOT kept on main — `docgen` is its +# only home (downstream docs tooling reads it from there). # # bundle/internal/schema/since_version.go derives `x-since-version` annotations # from the list of `v*` git tags that exist when the schema is generated. The @@ -68,43 +69,24 @@ jobs: echo "tag=$tag" >> "$GITHUB_OUTPUT" echo "Publishing for tag $tag" - - name: Regenerate jsonschema_for_docs.json - run: go tool -modfile=tools/task/go.mod task --force generate-schema-docs - - # Fail loudly if regeneration touches anything other than the docs schema. - # Anything else (annotations.yml, untracked files, ...) is a bug in the - # generator, not something we want to silently publish. - - name: Assert only jsonschema_for_docs.json changed on main - run: | - changed=$(git status --porcelain) - expected=" M bundle/schema/jsonschema_for_docs.json" - if [ -z "$changed" ]; then - echo "Regeneration produced no diff against main." - exit 0 - fi - if [ "$changed" != "$expected" ]; then - echo "Expected only bundle/schema/jsonschema_for_docs.json to be modified." - echo "Actual git status --porcelain:" - echo "$changed" - exit 1 - fi - - - name: Capture regenerated file - run: | - mkdir -p "$RUNNER_TEMP/regen" - cp bundle/schema/jsonschema_for_docs.json "$RUNNER_TEMP/regen/jsonschema_for_docs.json" - - name: Check out docgen worktree run: | git fetch origin docgen git worktree add "$RUNNER_TEMP/docgen" origin/docgen + # The docs schema is not kept on main; generate it straight into the docgen + # worktree and publish from there. since_version.go reads `git tag --list + # 'v*'` to stamp x-since-version; the tags are provided by the checkout + # above (fetch-depth: 0 + fetch-tags: true). + - name: Regenerate docs schema into the docgen worktree + run: | + mkdir -p "$RUNNER_TEMP/docgen/bundle/schema" + go run ./bundle/internal/schema ./bundle/internal/schema \ + "$RUNNER_TEMP/docgen/bundle/schema/jsonschema_for_docs.json" .codegen/cli.json --docs + - name: Stage regenerated file on docgen working-directory: ${{ runner.temp }}/docgen - run: | - mkdir -p bundle/schema - cp "$RUNNER_TEMP/regen/jsonschema_for_docs.json" bundle/schema/jsonschema_for_docs.json - git add bundle/schema/jsonschema_for_docs.json + run: git add bundle/schema/jsonschema_for_docs.json - name: Commit and push to docgen working-directory: ${{ runner.temp }}/docgen diff --git a/.wsignore b/.wsignore index c472fd672dd..fb58cddade1 100644 --- a/.wsignore +++ b/.wsignore @@ -3,7 +3,6 @@ .codegen/_openapi_sha .release_metadata.json bundle/schema/jsonschema.json -bundle/schema/jsonschema_for_docs.json python/docs/images/databricks-logo.svg **/*.dist-info/METADATA **/*.dist-info/WHEEL diff --git a/Taskfile.yml b/Taskfile.yml index 9c897eee591..9550bf5b799 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -55,7 +55,6 @@ tasks: - task: generate-refschema - task: generate-schema - task: generate-schema-map - - task: generate-schema-docs - task: generate-validation - task: generate-direct - task: pydabs-codegen @@ -726,7 +725,7 @@ tasks: # can be invoked standalone. generate: - desc: Run all generators (cligen, tf-schema, refschema, schema, docs, validation, direct, pydabs) + desc: Run all generators (cligen, tf-schema, refschema, schema, validation, direct, pydabs) cmds: # Runs first: regenerates CLI command stubs from the checked-in # .codegen/cli.json (no universe checkout needed). Refreshing cli.json @@ -740,7 +739,6 @@ tasks: # generate-direct-apitypes and generate-direct-resources below. - task: generate-refschema - task: generate-schema - - task: generate-schema-docs - task: generate-validation - task: generate-direct - task: pydabs-codegen @@ -752,9 +750,9 @@ tasks: # reproducible per-PR: # - generate-tf-schema downloads the Terraform provider, which no CI runner # sets up; its output only changes when schema/version.go changes. - # - generate-schema-docs stamps x-since-version from `git tag`, so it churns - # after every release; jsonschema_for_docs.json is published separately to - # the docgen branch by .github/workflows/update-schema-docs.yml. + # The docs schema (jsonschema_for_docs.json) is not generated here or on main + # at all — it is built and published to the docgen branch by + # .github/workflows/update-schema-docs.yml. # Keep this list in sync with `generate` when adding or removing generators. generate-check: desc: Run the reproducible generators (CI drift subset of `generate`) @@ -860,7 +858,8 @@ tasks: # bundle/internal/schema/annotations.yml carries the CLI-owned docs and # overrides and is rewritten in place (synced with the config structure). # Editing either input and running `task generate` percolates into - # jsonschema.json, jsonschema_for_docs.json and pydabs. + # jsonschema.json and pydabs. (The docs schema is built only on release by + # .github/workflows/update-schema-docs.yml and published to the docgen branch.) generate-schema: desc: Generate bundle JSON schema sources: &SCHEMA_SOURCES @@ -877,20 +876,6 @@ tasks: cmds: - "go run ./bundle/internal/schema ./bundle/internal/schema ./bundle/schema/jsonschema.json .codegen/cli.json" - generate-schema-docs: - desc: Generate bundle JSON schema for documentation - sources: *SCHEMA_SOURCES - generates: - - bundle/schema/jsonschema_for_docs.json - - bundle/internal/schema/annotations.yml - cmds: - # since_version.go reads `git tag --list 'v*'` to compute sinceVersion - # annotations. Without tags (e.g. shallow clone), those annotations are - # silently dropped from the output. Restore the fetch that lived in the - # old tools/post-generate.sh. - - git fetch origin 'refs/tags/v*:refs/tags/v*' - - "go run ./bundle/internal/schema ./bundle/internal/schema ./bundle/schema/jsonschema_for_docs.json .codegen/cli.json --docs" - generate-validation: desc: Generate enum and required field validation code sources: diff --git a/bundle/schema/.gitattributes b/bundle/schema/.gitattributes index f33e5e02470..0a03eb531b2 100644 --- a/bundle/schema/.gitattributes +++ b/bundle/schema/.gitattributes @@ -1,2 +1 @@ jsonschema.json linguist-generated=true -jsonschema_for_docs.json linguist-generated=true diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json deleted file mode 100644 index 68b01662512..00000000000 --- a/bundle/schema/jsonschema_for_docs.json +++ /dev/null @@ -1,11809 +0,0 @@ -{ - "$defs": { - "bool": { - "type": "boolean" - }, - "float64": { - "type": "number" - }, - "github.com": { - "databricks": { - "cli": { - "bundle": { - "config": { - "engine.EngineType": { - "type": "string", - "enum": [ - "terraform", - "direct" - ] - }, - "resources.Alert": { - "type": "object", - "properties": { - "custom_description": { - "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] Custom summary for the alert. support mustache template.", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - }, - "display_name": { - "description": "[Public Preview] The display name of the alert.", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - }, - "evaluation": { - "description": "[Public Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation", - "x-since-version": "v0.279.0" - }, - "file_path": { - "$ref": "#/$defs/string", - "x-since-version": "v0.282.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.279.0" - }, - "parent_path": { - "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" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", - "x-since-version": "v0.279.0" - }, - "query_text": { - "description": "[Public Preview] Text of the query to be run.", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - }, - "run_as": { - "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] 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", - "deprecated": true - }, - "schedule": { - "description": "[Public Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule", - "x-since-version": "v0.279.0" - }, - "warehouse_id": { - "description": "[Public Preview] ID of the SQL warehouse attached to the alert.", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false, - "required": [ - "display_name", - "evaluation", - "query_text", - "schedule", - "warehouse_id" - ] - }, - "resources.App": { - "type": "object", - "properties": { - "budget_policy_id": { - "description": "[Public Preview]", - "$ref": "#/$defs/string", - "x-since-version": "v0.243.0" - }, - "compute_max_instances": { - "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] Minimum number of app instances. Must be set together with `compute_max_instances`.", - "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.2.0" - }, - "compute_size": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ComputeSize", - "x-since-version": "v0.273.0" - }, - "config": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.AppConfig", - "x-since-version": "v0.239.0" - }, - "description": { - "description": "The description of the app.", - "$ref": "#/$defs/string", - "x-since-version": "v0.239.0" - }, - "git_repository": { - "description": "Git repository configuration for app deployments. When specified, deployments can\nreference code from this repository by providing only the git reference (branch, tag, or commit).", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitRepository", - "x-since-version": "v0.283.0" - }, - "git_source": { - "description": "Git source configuration for app deployments. Specifies which git reference (branch, tag, or commit)\nto use when deploying the app. Used in conjunction with git_repository to deploy code directly from git.\nThe source_code_path within git_source specifies the relative path to the app code within the repository.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitSource", - "x-since-version": "v0.290.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace.", - "$ref": "#/$defs/string", - "x-since-version": "v0.239.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.AppPermission", - "x-since-version": "v0.239.0" - }, - "resources": { - "description": "Resources for the app.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.AppResource", - "x-since-version": "v0.239.0" - }, - "source_code_path": { - "$ref": "#/$defs/string", - "x-since-version": "v0.239.0" - }, - "space": { - "description": "[Private Preview] Name of the space this app belongs to.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.290.0" - }, - "telemetry_export_destinations": { - "description": "[Public Preview]", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination", - "x-since-version": "v0.294.0" - }, - "usage_policy_id": { - "description": "[Public Preview]", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "user_api_scopes": { - "description": "[Public Preview]", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.246.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ] - }, - "resources.AppConfig": { - "type": "object", - "properties": { - "command": { - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.283.0" - }, - "env": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.AppEnvVar", - "x-since-version": "v0.283.0" - } - }, - "additionalProperties": false - }, - "resources.AppEnvVar": { - "type": "object", - "properties": { - "name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "value": { - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "value_from": { - "$ref": "#/$defs/string", - "x-since-version": "v0.284.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ] - }, - "resources.AppPermission": { - "type": "object", - "properties": { - "group_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "level": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppPermissionLevel", - "x-since-version": "v0.247.0" - }, - "service_principal_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "user_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.Catalog": { - "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" - }, - "custom_max_retention_hours": { - "description": "[Public Preview] Custom maximum retention period in hours for the catalog", - "$ref": "#/$defs/int64" - }, - "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", - "x-since-version": "v0.287.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.287.0" - }, - "managed_encryption_settings": { - "description": "Control CMK encryption for managed catalog data", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionSettings", - "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" - } - }, - "additionalProperties": false, - "required": [ - "name" - ] - }, - "resources.Cluster": { - "type": "object", - "description": "Contains a snapshot of the latest user specified settings that were used to create/edit the cluster.", - "properties": { - "apply_policy_default_values": { - "description": "When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "autoscale": { - "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AutoScale", - "x-since-version": "v0.229.0" - }, - "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "aws_attributes": { - "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes", - "x-since-version": "v0.229.0" - }, - "azure_attributes": { - "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes", - "x-since-version": "v0.229.0" - }, - "cluster_log_conf": { - "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf", - "x-since-version": "v0.229.0" - }, - "cluster_name": { - "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "custom_tags": { - "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", - "$ref": "#/$defs/map/string", - "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" - }, - "driver_instance_pool_id": { - "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "driver_node_type_flexibility": { - "description": "Flexible node type configuration for the driver node.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", - "x-since-version": "v0.285.0" - }, - "driver_node_type_id": { - "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "enable_elastic_disk": { - "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "enable_local_disk_encryption": { - "description": "Whether to enable LUKS on cluster VMs' local disks", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "gcp_attributes": { - "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes", - "x-since-version": "v0.229.0" - }, - "init_scripts": { - "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo", - "x-since-version": "v0.229.0" - }, - "instance_pool_id": { - "description": "The optional ID of the instance pool to which the cluster belongs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "is_single_node": { - "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", - "$ref": "#/$defs/bool", - "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" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", - "x-since-version": "v0.268.0" - }, - "node_type_id": { - "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "num_workers": { - "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.ClusterPermission", - "x-since-version": "v0.229.0" - }, - "policy_id": { - "description": "The ID of the cluster policy used to create the cluster if applicable.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "remote_disk_throughput": { - "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", - "$ref": "#/$defs/int", - "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" - }, - "single_user_name": { - "description": "Single user name if data_security_mode is `SINGLE_USER`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "spark_conf": { - "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "spark_env_vars": { - "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "spark_version": { - "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "ssh_public_keys": { - "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "total_initial_remote_disk_size": { - "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", - "$ref": "#/$defs/int", - "x-since-version": "v0.257.0" - }, - "use_ml_runtime": { - "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.237.0" - }, - "worker_node_type_flexibility": { - "description": "Flexible node type configuration for worker nodes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", - "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" - } - }, - "additionalProperties": false, - "markdownDescription": "The cluster resource defines an [all-purpose cluster](https://docs.databricks.com/api/workspace/clusters/create)." - }, - "resources.ClusterPermission": { - "type": "object", - "properties": { - "group_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "level": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterPermissionLevel", - "x-since-version": "v0.247.0" - }, - "service_principal_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "user_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.Dashboard": { - "type": "object", - "properties": { - "create_time": { - "description": "The timestamp of when the dashboard was created.", - "$ref": "#/$defs/string", - "x-since-version": "v0.234.0" - }, - "dashboard_id": { - "description": "UUID identifying the dashboard.", - "$ref": "#/$defs/string", - "x-since-version": "v0.234.0" - }, - "dataset_catalog": { - "description": "Sets the default catalog for all datasets in this dashboard. When set, this overrides the catalog specified in individual dataset definitions.", - "$ref": "#/$defs/string", - "x-since-version": "v0.281.0" - }, - "dataset_schema": { - "description": "Sets the default schema for all datasets in this dashboard. When set, this overrides the schema specified in individual dataset definitions.", - "$ref": "#/$defs/string", - "x-since-version": "v0.281.0" - }, - "display_name": { - "description": "The display name of the dashboard.", - "$ref": "#/$defs/string", - "x-since-version": "v0.232.0" - }, - "embed_credentials": { - "$ref": "#/$defs/bool", - "x-since-version": "v0.232.0" - }, - "etag": { - "description": "The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard\nhas not been modified since the last read.\nThis field is excluded in List Dashboards responses.", - "$ref": "#/$defs/string", - "x-since-version": "v0.234.0" - }, - "file_path": { - "$ref": "#/$defs/string", - "x-since-version": "v0.232.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "lifecycle_state": { - "description": "The state of the dashboard resource. Used for tracking trashed status.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dashboards.LifecycleState", - "x-since-version": "v0.234.0" - }, - "parent_path": { - "description": "The workspace path of the folder containing the dashboard. Includes leading slash and no\ntrailing slash.\nThis field is excluded in List Dashboards responses.", - "$ref": "#/$defs/string", - "x-since-version": "v0.232.0" - }, - "path": { - "description": "The workspace path of the dashboard asset, including the file name.\nExported dashboards always have the file extension `.lvdash.json`.\nThis field is excluded in List Dashboards responses.", - "$ref": "#/$defs/string", - "x-since-version": "v0.234.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", - "x-since-version": "v0.232.0" - }, - "serialized_dashboard": { - "description": "The contents of the dashboard in serialized string form.\nThis field is excluded in List Dashboards responses.\nUse the [get dashboard API](https://docs.databricks.com/api/workspace/lakeview/get)\nto retrieve an example response, which includes the `serialized_dashboard` field.\nThis field provides the structure of the JSON string that represents the dashboard's\nlayout and components.", - "$ref": "#/$defs/interface", - "x-since-version": "v0.232.0" - }, - "update_time": { - "description": "The timestamp of when the dashboard was last updated by the user.\nThis field is excluded in List Dashboards responses.", - "$ref": "#/$defs/string", - "x-since-version": "v0.234.0" - }, - "warehouse_id": { - "description": "The warehouse ID used to run the dashboard.", - "$ref": "#/$defs/string", - "x-since-version": "v0.232.0" - } - }, - "additionalProperties": false, - "markdownDescription": "The dashboard resource allows you to manage [AI/BI dashboards](https://docs.databricks.com/api/workspace/lakeview/create) in a bundle. For information about AI/BI dashboards, see [link](https://docs.databricks.com/dashboards/index.html)." - }, - "resources.DatabaseCatalog": { - "type": "object", - "properties": { - "create_database_if_not_exists": { - "description": "[Public Preview]", - "$ref": "#/$defs/bool", - "x-since-version": "v0.265.0" - }, - "database_instance_name": { - "description": "[Public Preview] The name of the DatabaseInstance housing the database.", - "$ref": "#/$defs/string", - "x-since-version": "v0.265.0" - }, - "database_name": { - "description": "[Public Preview] The name of the database (in an instance) associated with the catalog.", - "$ref": "#/$defs/string", - "x-since-version": "v0.265.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "[Public Preview] The name of the catalog in UC.", - "$ref": "#/$defs/string", - "x-since-version": "v0.265.0" - } - }, - "additionalProperties": false, - "required": [ - "database_instance_name", - "database_name", - "name" - ] - }, - "resources.DatabaseInstance": { - "type": "object", - "description": "A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.", - "properties": { - "capacity": { - "description": "[Public Preview] The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", - "$ref": "#/$defs/string", - "x-since-version": "v0.265.0" - }, - "custom_tags": { - "description": "[Beta] Custom tags associated with the instance. This field is only included on create and update responses.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.CustomTag", - "x-since-version": "v0.273.0" - }, - "enable_pg_native_login": { - "description": "[Public Preview] Whether to enable PG native password login on the instance. Defaults to false.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.267.0" - }, - "enable_readable_secondaries": { - "description": "[Public Preview] Whether to enable secondaries to serve read-only traffic. Defaults to false.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.265.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "[Public Preview] The name of the instance. This is the unique identifier for the instance.", - "$ref": "#/$defs/string", - "x-since-version": "v0.265.0" - }, - "node_count": { - "description": "[Public Preview] The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see effective_node_count for the output.", - "$ref": "#/$defs/int", - "x-since-version": "v0.265.0" - }, - "parent_instance_ref": { - "description": "[Public Preview] The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef", - "x-since-version": "v0.265.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", - "x-since-version": "v0.265.0" - }, - "retention_window_in_days": { - "description": "[Public Preview] The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days.", - "$ref": "#/$defs/int", - "x-since-version": "v0.265.0" - }, - "stopped": { - "description": "[Public Preview] Whether to stop the instance. An input only param, see effective_stopped for the output.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.265.0" - }, - "usage_policy_id": { - "description": "[Beta] The desired usage policy to associate with the instance.", - "$ref": "#/$defs/string", - "x-since-version": "v0.273.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ] - }, - "resources.ExternalLocation": { - "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" - }, - "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", - "x-since-version": "v0.289.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "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" - } - }, - "additionalProperties": false, - "required": [ - "credential_name", - "name", - "url" - ] - }, - "resources.GenieSpace": { - "type": "object", - "properties": { - "description": { - "description": "Description of the Genie space shown alongside the title in the Databricks UI.", - "$ref": "#/$defs/string", - "x-since-version": "v1.3.0" - }, - "etag": { - "$ref": "#/$defs/string", - "x-since-version": "v1.3.0" - }, - "file_path": { - "description": "Local path to a `.geniespace.json` file holding the serialized Genie space definition. The contents are inlined into `serialized_space` at deploy time. Mutually exclusive with an inline `serialized_space`.", - "$ref": "#/$defs/string", - "x-since-version": "v1.3.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v1.3.0" - }, - "parent_path": { - "description": "Workspace folder under which to create the Genie space. Immutable: changing this field recreates the resource.", - "$ref": "#/$defs/string", - "x-since-version": "v1.3.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", - "x-since-version": "v1.3.0" - }, - "serialized_space": { - "description": "Serialized Genie space body. May be provided inline as a JSON string (or YAML that will be marshalled to JSON) or referenced via `file_path`. To round-trip an existing space into a bundle, use `databricks bundle generate genie-space`.", - "$ref": "#/$defs/interface", - "x-since-version": "v1.3.0" - }, - "title": { - "description": "Title of the Genie space shown in the Databricks UI.", - "$ref": "#/$defs/string", - "x-since-version": "v1.3.0" - }, - "warehouse_id": { - "description": "ID of the SQL warehouse used to run queries for this Genie space.", - "$ref": "#/$defs/string", - "x-since-version": "v1.3.0" - } - }, - "additionalProperties": false - }, - "resources.Job": { - "type": "object", - "properties": { - "budget_policy_id": { - "description": "[Public Preview] The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", - "$ref": "#/$defs/string", - "x-since-version": "v0.231.0" - }, - "continuous": { - "description": "An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of `schedule` and `continuous` can be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Continuous", - "x-since-version": "v0.229.0" - }, - "description": { - "description": "An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "email_notifications": { - "description": "An optional set of email addresses that is notified when runs of this job begin or complete as well as when this job is deleted.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEmailNotifications", - "x-since-version": "v0.229.0" - }, - "environments": { - "description": "A list of task execution environment specifications that can be referenced by serverless tasks of this job.\nFor serverless notebook tasks, if the environment_key is not specified, the notebook environment will be used if present. If a jobs environment is specified, it will override the notebook environment.\nFor other serverless tasks, the task environment is required to be specified using environment_key in the task settings.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironment", - "x-since-version": "v0.229.0" - }, - "git_source": { - "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GitSource", - "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" - }, - "job_clusters": { - "description": "A list of job cluster specifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobCluster", - "x-since-version": "v0.229.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "max_concurrent_runs": { - "description": "An optional maximum allowed number of concurrent runs of the job.\nSet this value if you want to be able to execute multiple runs of the same job concurrently.\nThis is useful for example if you trigger your job on a frequent schedule and want to allow consecutive runs to overlap with each other, or if you want to trigger multiple runs which differ by their input parameters.\nThis setting affects only new runs. For example, suppose the job’s concurrency is 4 and there are 4 concurrent active runs. Then setting the concurrency to 3 won’t kill any of the active runs.\nHowever, from then on, new runs are skipped unless there are fewer than 3 active runs.\nThis value cannot exceed 1000. Setting this value to `0` causes all new runs to be skipped.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "name": { - "description": "An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "notification_settings": { - "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this job.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobNotificationSettings", - "x-since-version": "v0.229.0" - }, - "parameters": { - "description": "Job-level parameter definitions", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobParameterDefinition", - "x-since-version": "v0.229.0" - }, - "performance_target": { - "description": "The performance mode on a serverless job. This field determines the level of compute performance or cost-efficiency for the run.\nThe performance target does not apply to tasks that run on Serverless GPU compute.\n\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PerformanceTarget", - "x-since-version": "v0.241.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.JobPermission", - "x-since-version": "v0.229.0" - }, - "queue": { - "description": "The queue settings of the job.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings", - "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" - }, - "schedule": { - "description": "An optional periodic schedule for this job. The default behavior is that the job only runs when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CronSchedule", - "x-since-version": "v0.229.0" - }, - "tags": { - "description": "A map of tags associated with the job. These are forwarded to the cluster as cluster tags for jobs clusters, and are subject to the same limitations as cluster tags. A maximum of 25 tags can be added to the job.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "tasks": { - "description": "A list of task specifications to be executed by this job.\nIt supports up to 1000 elements in write endpoints (:method:jobs/create, :method:jobs/reset, :method:jobs/update, :method:jobs/submit).\nRead endpoints return only 100 tasks. If more than 100 tasks are available, you can paginate through them using :method:jobs/get. Use the `next_page_token` field at the object root to determine if more results are available.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Task", - "x-since-version": "v0.229.0" - }, - "timeout_seconds": { - "description": "An optional timeout applied to each run of this job. A value of `0` means no timeout.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "trigger": { - "description": "A configuration to trigger a run when certain conditions are met. The default behavior is that the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TriggerSettings", - "x-since-version": "v0.229.0" - }, - "usage_policy_id": { - "description": "[Private Preview] The id of the user specified usage policy to use for this job.\nIf not specified, a default usage policy may be applied when creating or modifying the job.\nSee `effective_usage_policy_id` for the usage policy used by this workload.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.265.0" - }, - "webhook_notifications": { - "description": "A collection of system notification IDs to notify when runs of this job begin or complete.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "markdownDescription": "The job resource allows you to define [jobs and their corresponding tasks](https://docs.databricks.com/api/workspace/jobs/create) in your bundle. For information about jobs, see [link](https://docs.databricks.com/jobs/index.html). For a tutorial that uses a Declarative Automation Bundles template to create a job, see [link](https://docs.databricks.com/dev-tools/bundles/jobs-tutorial.html)." - }, - "resources.JobPermission": { - "type": "object", - "properties": { - "group_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "level": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobPermissionLevel", - "x-since-version": "v0.247.0" - }, - "service_principal_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "user_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.Lifecycle": { - "type": "object", - "properties": { - "prevent_destroy": { - "description": "Lifecycle setting to prevent the resource from being destroyed.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.268.0" - } - }, - "additionalProperties": false - }, - "resources.LifecycleWithStarted": { - "type": "object", - "properties": { - "prevent_destroy": { - "description": "Lifecycle setting to prevent the resource from being destroyed.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.297.0" - }, - "started": { - "description": "Lifecycle setting to deploy the resource in started mode. Only supported for apps, clusters, and sql_warehouses in direct deployment mode.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.297.0" - } - }, - "additionalProperties": false - }, - "resources.MlflowExperiment": { - "type": "object", - "properties": { - "artifact_location": { - "description": "Location where all artifacts for the experiment are stored.\nIf not provided, the remote server will select an appropriate default.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "Experiment name.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.MlflowExperimentPermission", - "x-since-version": "v0.229.0" - }, - "tags": { - "description": "A collection of tags to set on the experiment. Maximum tag size and number of tags per request\ndepends on the storage backend. All storage backends are guaranteed to support tag keys up\nto 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also\nguaranteed to support up to 20 tags per request.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTag", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ], - "markdownDescription": "The experiment resource allows you to define [MLflow experiments](https://docs.databricks.com/api/workspace/experiments/createexperiment) in a bundle. For information about MLflow experiments, see [link](https://docs.databricks.com/mlflow/experiments.html)." - }, - "resources.MlflowExperimentPermission": { - "type": "object", - "properties": { - "group_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "level": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ExperimentPermissionLevel", - "x-since-version": "v0.247.0" - }, - "service_principal_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "user_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.MlflowModel": { - "type": "object", - "properties": { - "description": { - "description": "Optional description for registered model.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "Register models under this name", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.MlflowModelPermission", - "x-since-version": "v0.229.0" - }, - "tags": { - "description": "Additional metadata for registered model.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelTag", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ], - "markdownDescription": "The model resource allows you to define [legacy models](https://docs.databricks.com/api/workspace/modelregistry/createmodel) in bundles. Databricks recommends you use Unity Catalog [registered models](https://docs.databricks.com/dev-tools/bundles/reference.html#registered-model) instead." - }, - "resources.MlflowModelPermission": { - "type": "object", - "properties": { - "group_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "level": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.RegisteredModelPermissionLevel", - "x-since-version": "v0.247.0" - }, - "service_principal_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "user_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.ModelServingEndpoint": { - "type": "object", - "properties": { - "ai_gateway": { - "description": "The AI Gateway configuration for the serving endpoint. NOTE: External model, provisioned throughput, and pay-per-token endpoints are fully supported; agent endpoints currently only support inference tables.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayConfig", - "x-since-version": "v0.230.0" - }, - "budget_policy_id": { - "description": "The budget policy to be applied to the serving endpoint.", - "$ref": "#/$defs/string", - "x-since-version": "v0.244.0" - }, - "config": { - "description": "The core config of the serving endpoint.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EndpointCoreConfigInput", - "x-since-version": "v0.229.0" - }, - "description": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "email_notifications": { - "description": "Email notification settings.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EmailNotifications", - "x-since-version": "v0.264.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "The name of the serving endpoint. This field is required and must be unique across a Databricks workspace.\nAn endpoint name can consist of alphanumeric characters, dashes, and underscores.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.ModelServingEndpointPermission", - "x-since-version": "v0.229.0" - }, - "rate_limits": { - "description": "Rate limits to be applied to the serving endpoint. NOTE: this field is deprecated, please use AI Gateway to manage rate limits.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.RateLimit", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "route_optimized": { - "description": "Enable route optimization for the serving endpoint.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "tags": { - "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.EndpointTag", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ], - "markdownDescription": "The model_serving_endpoint resource allows you to define [model serving endpoints](https://docs.databricks.com/api/workspace/servingendpoints/create). See [link](https://docs.databricks.com/machine-learning/model-serving/manage-serving-endpoints.html)." - }, - "resources.ModelServingEndpointPermission": { - "type": "object", - "properties": { - "group_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "level": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServingEndpointPermissionLevel", - "x-since-version": "v0.247.0" - }, - "service_principal_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "user_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.Permission": { - "type": "object", - "properties": { - "group_name": { - "description": "The name of the group that has the permission set in level.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "level": { - "description": "The allowed permission for user, group, service principal defined for this permission.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/iam.PermissionLevel", - "x-since-version": "v0.229.0" - }, - "service_principal_name": { - "description": "The name of the service principal that has the permission set in level.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "user_name": { - "description": "The name of the user that has the permission set in level.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.Pipeline": { - "type": "object", - "properties": { - "allow_duplicate_names": { - "description": "If false, deployment will fail if name conflicts with that of another pipeline.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.261.0" - }, - "budget_policy_id": { - "description": "[Public Preview] Budget policy of this pipeline.", - "$ref": "#/$defs/string", - "x-since-version": "v0.230.0" - }, - "catalog": { - "description": "A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "channel": { - "description": "SDP Release Channel that specifies which version to use.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "clusters": { - "description": "Cluster settings for this pipeline deployment.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster", - "x-since-version": "v0.229.0" - }, - "configuration": { - "description": "String-String configuration for this pipeline execution.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "continuous": { - "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "development": { - "description": "Whether the pipeline is in Development mode. Defaults to false.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "edition": { - "description": "Pipeline product edition.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "environment": { - "description": "[Public Preview] Environment specification for this pipeline used to install dependencies.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment", - "x-since-version": "v0.257.0" - }, - "event_log": { - "description": "Event log configuration for this pipeline", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.EventLogSpec", - "x-since-version": "v0.246.0" - }, - "filters": { - "description": "Filters on which Pipeline packages to include in the deployed graph.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Filters", - "x-since-version": "v0.229.0" - }, - "gateway_definition": { - "description": "[Private Preview] The definition of a gateway pipeline to support change data capture.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - }, - "id": { - "description": "Unique identifier for this pipeline.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "ingestion_definition": { - "description": "[Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition", - "x-since-version": "v0.229.0" - }, - "libraries": { - "description": "Libraries or code needed by this deployment.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary", - "x-since-version": "v0.229.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "Friendly identifier for this pipeline.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "notifications": { - "description": "List of notification settings for this pipeline.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications", - "x-since-version": "v0.229.0" - }, - "parameters": { - "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" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.PipelinePermission", - "x-since-version": "v0.229.0" - }, - "photon": { - "description": "Whether Photon is enabled for this pipeline.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "restart_window": { - "description": "[Private Preview] Restart window of this pipeline.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.234.0" - }, - "root_path": { - "description": "[Public Preview] Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", - "$ref": "#/$defs/string", - "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" - }, - "schema": { - "description": "The default schema (database) where tables are read from or published to.", - "$ref": "#/$defs/string", - "x-since-version": "v0.230.0" - }, - "serverless": { - "description": "Whether serverless compute is enabled for this pipeline.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "serverless_compute_id": { - "description": "[Private Preview] Serverless compute ID specified by the user for serverless pipelines.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - }, - "storage": { - "description": "DBFS root directory for storing checkpoints and tables.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "tags": { - "description": "A map of tags associated with the pipeline.\nThese are forwarded to the cluster as cluster tags, and are therefore subject to the same limitations.\nA maximum of 25 tags can be added to the pipeline.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.256.0" - }, - "target": { - "description": "Target schema (database) to add tables in this pipeline to. Exactly one of `schema` or `target` must be specified. To publish to Unity Catalog, also specify `catalog`. This legacy field is deprecated for pipeline creation in favor of the `schema` field.", - "$ref": "#/$defs/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "trigger": { - "description": "Which pipeline trigger to use. Deprecated: Use `continuous` instead.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineTrigger", - "deprecationMessage": "Use continuous instead", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "usage_policy_id": { - "description": "[Private Preview] Usage policy of this pipeline.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.276.0" - } - }, - "additionalProperties": false, - "markdownDescription": "This resource allows you to create [pipelines](https://docs.databricks.com/api/workspace/pipelines/create). For information about pipelines, see [link](https://docs.databricks.com/dlt/index.html). For a tutorial that uses the Declarative Automation Bundles template to create a pipeline, see [link](https://docs.databricks.com/dev-tools/bundles/pipelines-tutorial.html)." - }, - "resources.PipelinePermission": { - "type": "object", - "properties": { - "group_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "level": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinePermissionLevel", - "x-since-version": "v0.247.0" - }, - "service_principal_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - }, - "user_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.247.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.PostgresBranch": { - "type": "object", - "properties": { - "branch_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.287.0" - }, - "expire_time": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", - "x-since-version": "v0.287.0" - }, - "is_protected": { - "$ref": "#/$defs/bool", - "x-since-version": "v0.287.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.287.0" - }, - "no_expiry": { - "$ref": "#/$defs/bool", - "x-since-version": "v0.287.0" - }, - "parent": { - "$ref": "#/$defs/string", - "x-since-version": "v0.287.0" - }, - "replace_existing": { - "$ref": "#/$defs/bool", - "x-since-version": "v1.0.0" - }, - "source_branch": { - "$ref": "#/$defs/string", - "x-since-version": "v0.287.0" - }, - "source_branch_lsn": { - "$ref": "#/$defs/string", - "x-since-version": "v0.287.0" - }, - "source_branch_time": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", - "x-since-version": "v0.287.0" - }, - "ttl": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", - "x-since-version": "v0.287.0" - } - }, - "additionalProperties": false, - "required": [ - "branch_id", - "parent" - ] - }, - "resources.PostgresCatalog": { - "type": "object", - "properties": { - "branch": { - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "catalog_id": { - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "create_database_if_missing": { - "$ref": "#/$defs/bool", - "x-since-version": "v1.0.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v1.0.0" - }, - "postgres_database": { - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - } - }, - "additionalProperties": false, - "required": [ - "catalog_id", - "postgres_database" - ] - }, - "resources.PostgresDatabase": { - "type": "object", - "properties": { - "database_id": { - "$ref": "#/$defs/string", - "x-since-version": "v1.4.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v1.4.0" - }, - "parent": { - "$ref": "#/$defs/string", - "x-since-version": "v1.4.0" - }, - "postgres_database": { - "$ref": "#/$defs/string", - "x-since-version": "v1.4.0" - }, - "role": { - "$ref": "#/$defs/string", - "x-since-version": "v1.4.0" - } - }, - "additionalProperties": false, - "required": [ - "database_id", - "parent" - ] - }, - "resources.PostgresEndpoint": { - "type": "object", - "properties": { - "autoscaling_limit_max_cu": { - "$ref": "#/$defs/float64", - "x-since-version": "v0.287.0" - }, - "autoscaling_limit_min_cu": { - "$ref": "#/$defs/float64", - "x-since-version": "v0.287.0" - }, - "disabled": { - "$ref": "#/$defs/bool", - "x-since-version": "v0.287.0" - }, - "endpoint_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.287.0" - }, - "endpoint_type": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointType", - "x-since-version": "v0.287.0" - }, - "group": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec", - "x-since-version": "v0.290.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.287.0" - }, - "no_suspension": { - "$ref": "#/$defs/bool", - "x-since-version": "v0.287.0" - }, - "parent": { - "$ref": "#/$defs/string", - "x-since-version": "v0.287.0" - }, - "replace_existing": { - "$ref": "#/$defs/bool", - "x-since-version": "v1.0.0" - }, - "settings": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings", - "x-since-version": "v0.287.0" - }, - "suspend_timeout_duration": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", - "x-since-version": "v0.287.0" - } - }, - "additionalProperties": false, - "required": [ - "endpoint_id", - "parent", - "endpoint_type" - ] - }, - "resources.PostgresProject": { - "type": "object", - "properties": { - "budget_policy_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.290.0" - }, - "custom_tags": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.ProjectCustomTag", - "x-since-version": "v0.290.0" - }, - "default_branch": { - "$ref": "#/$defs/string", - "x-since-version": "v0.298.0" - }, - "default_endpoint_settings": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.ProjectDefaultEndpointSettings", - "x-since-version": "v0.287.0" - }, - "display_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.287.0" - }, - "enable_pg_native_login": { - "$ref": "#/$defs/bool", - "x-since-version": "v0.294.0" - }, - "history_retention_duration": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", - "x-since-version": "v0.287.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.287.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", - "x-since-version": "v0.292.0" - }, - "pg_version": { - "$ref": "#/$defs/int", - "x-since-version": "v0.287.0" - }, - "project_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.287.0" - }, - "purge_on_delete": { - "$ref": "#/$defs/bool", - "x-since-version": "v1.2.0" - } - }, - "additionalProperties": false, - "required": [ - "project_id" - ] - }, - "resources.PostgresRole": { - "type": "object", - "properties": { - "attributes": { - "description": "The desired API-exposed Postgres role attributes to associate with the role.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleAttributes", - "x-since-version": "v1.4.0" - }, - "auth_method": { - "description": "How the role is authenticated when connecting to Postgres. If left unspecified, a meaningful authentication method is derived from the identity_type.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleAuthMethod", - "x-since-version": "v1.4.0" - }, - "identity_type": { - "description": "The type of the Databricks managed identity that this Role represents. Leave empty to create a regular Postgres role not associated with a Databricks identity.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleIdentityType", - "x-since-version": "v1.4.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v1.4.0" - }, - "membership_roles": { - "description": "Standard roles that this role is a member of.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.RoleMembershipRole", - "x-since-version": "v1.4.0" - }, - "parent": { - "description": "The branch where this role is created. Format projects/{project_id}/branches/{branch_id}.", - "$ref": "#/$defs/string", - "x-since-version": "v1.4.0" - }, - "postgres_role": { - "description": "The name of the Postgres role. Required when creating the role.", - "$ref": "#/$defs/string", - "x-since-version": "v1.4.0" - }, - "role_id": { - "description": "The user-specified role ID; becomes the final component of the role's resource name. Must be 4-63 characters, lowercase letters, numbers, and hyphens (RFC 1123).", - "$ref": "#/$defs/string", - "x-since-version": "v1.4.0" - } - }, - "additionalProperties": false, - "required": [ - "role_id", - "parent" - ] - }, - "resources.PostgresSyncedTable": { - "type": "object", - "properties": { - "accelerated_sync": { - "$ref": "#/$defs/bool" - }, - "branch": { - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "create_database_objects_if_missing": { - "$ref": "#/$defs/bool", - "x-since-version": "v1.0.0" - }, - "existing_pipeline_id": { - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v1.0.0" - }, - "new_pipeline_spec": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.NewPipelineSpec", - "x-since-version": "v1.0.0" - }, - "postgres_database": { - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "primary_key_columns": { - "$ref": "#/$defs/slice/string", - "x-since-version": "v1.0.0" - }, - "scheduling_policy": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy", - "x-since-version": "v1.0.0" - }, - "source_table_full_name": { - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "synced_table_id": { - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "timeseries_key": { - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "type_overrides": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecTypeOverride" - } - }, - "additionalProperties": false, - "required": [ - "synced_table_id" - ] - }, - "resources.QualityMonitor": { - "type": "object", - "properties": { - "assets_dir": { - "description": "[Create:REQ Update:IGN] Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "baseline_table_name": { - "description": "[Create:OPT Update:OPT] Baseline table name.\nBaseline data is used to compute drift from the data in the monitored `table_name`.\nThe baseline table and the monitored table shall have the same schema.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "custom_metrics": { - "description": "[Create:OPT Update:OPT] Custom metrics.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetric", - "x-since-version": "v0.229.0" - }, - "data_classification_config": { - "description": "[Private Preview] [Create:OPT Update:OPT] Data classification related config.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificationConfig", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - }, - "inference_log": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLog", - "x-since-version": "v0.229.0" - }, - "latest_monitor_failure_msg": { - "description": "[Create:ERR Update:IGN] The latest error message for a monitor failure.", - "$ref": "#/$defs/string", - "x-since-version": "v0.264.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "notifications": { - "description": "[Create:OPT Update:OPT] Field for specifying notification settings.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorNotifications", - "x-since-version": "v0.229.0" - }, - "output_schema_name": { - "description": "[Create:REQ Update:REQ] Schema where output tables are created. Needs to be in 2-level format {catalog}.{schema}", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "schedule": { - "description": "[Create:OPT Update:OPT] The monitor schedule.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorCronSchedule", - "x-since-version": "v0.229.0" - }, - "skip_builtin_dashboard": { - "description": "Whether to skip creating a default dashboard summarizing data quality metrics.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "slicing_exprs": { - "description": "[Create:OPT Update:OPT] List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for `col_2 \u003e 10` (True and False), and one slice per unique value in\n`col1`. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "snapshot": { - "description": "Configuration for monitoring snapshot tables.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorSnapshot", - "x-since-version": "v0.229.0" - }, - "table_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.235.0" - }, - "time_series": { - "description": "Configuration for monitoring time series tables.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorTimeSeries", - "x-since-version": "v0.229.0" - }, - "warehouse_id": { - "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "table_name", - "assets_dir", - "output_schema_name" - ], - "markdownDescription": "The quality_monitor resource allows you to define a Unity Catalog [table monitor](https://docs.databricks.com/api/workspace/qualitymonitors/create). For information about monitors, see [link](https://docs.databricks.com/machine-learning/model-serving/monitor-diagnose-endpoints.html)." - }, - "resources.RegisteredModel": { - "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" - }, - "catalog_name": { - "description": "The name of the catalog where the schema and the registered model reside", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "comment": { - "description": "The comment attached to the registered model", - "$ref": "#/$defs/string", - "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" - }, - "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", - "x-since-version": "v0.229.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "metastore_id": { - "description": "The unique identifier of the metastore", - "$ref": "#/$defs/string", - "x-since-version": "v0.273.0" - }, - "name": { - "description": "The name of the registered model", - "$ref": "#/$defs/string", - "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" - }, - "schema_name": { - "description": "The name of the schema where the registered model resides", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "storage_location": { - "description": "The storage location on the cloud under which model version data files are stored", - "$ref": "#/$defs/string", - "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" - } - }, - "additionalProperties": false, - "markdownDescription": "The registered model resource allows you to define models in Unity Catalog. For information about Unity Catalog [registered models](https://docs.databricks.com/api/workspace/registeredmodels/create), see [link](https://docs.databricks.com/machine-learning/manage-model-lifecycle/index.html)." - }, - "resources.Schema": { - "type": "object", - "properties": { - "catalog_name": { - "description": "Name of parent catalog.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "comment": { - "description": "User-provided free-form text description.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "custom_max_retention_hours": { - "description": "[Public Preview] Custom maximum retention period in hours for the schema.", - "$ref": "#/$defs/int64" - }, - "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", - "x-since-version": "v0.229.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "Name of schema, relative to parent catalog.", - "$ref": "#/$defs/string", - "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" - }, - "storage_root": { - "description": "Storage root URL for managed tables within schema.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "catalog_name", - "name" - ], - "markdownDescription": "The schema resource type allows you to define Unity Catalog [schemas](https://docs.databricks.com/api/workspace/schemas/create) for tables and other assets in your jobs and pipelines created as part of a bundle. A schema, different from other resource types, has the following limitations:\n\n- The owner of a schema resource is always the deployment user, and cannot be changed. If `run_as` is specified in the bundle, it will be ignored by operations on the schema.\n- Only fields supported by the corresponding [Schemas object create API](https://docs.databricks.com/api/workspace/schemas/create) are available for the schema resource. For example, `enable_predictive_optimization` is not supported as it is only available on the [update API](https://docs.databricks.com/api/workspace/schemas/update)." - }, - "resources.SecretScope": { - "type": "object", - "properties": { - "backend_type": { - "description": "The backend type the scope will be created with. If not specified, will default to `DATABRICKS`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/workspace.ScopeBackendType", - "x-since-version": "v0.252.0" - }, - "keyvault_metadata": { - "description": "The metadata for the secret scope if the `backend_type` is `AZURE_KEYVAULT`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/workspace.AzureKeyVaultSecretScopeMetadata", - "x-since-version": "v0.252.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "Scope name requested by the user. Scope names are unique.", - "$ref": "#/$defs/string", - "x-since-version": "v0.252.0" - }, - "permissions": { - "description": "The permissions to apply to the secret scope. Permissions are managed via secret scope ACLs.", - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.SecretScopePermission", - "x-since-version": "v0.252.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ] - }, - "resources.SecretScopePermission": { - "type": "object", - "properties": { - "group_name": { - "description": "The name of the group that has the permission set in level. This field translates to a `principal` field in secret scope ACL.", - "$ref": "#/$defs/string", - "x-since-version": "v0.252.0" - }, - "level": { - "description": "The allowed permission for user, group, service principal defined for this permission.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.SecretScopePermissionLevel", - "x-since-version": "v0.252.0" - }, - "service_principal_name": { - "description": "The application ID of an active service principal. This field translates to a `principal` field in secret scope ACL.", - "$ref": "#/$defs/string", - "x-since-version": "v0.252.0" - }, - "user_name": { - "description": "The name of the user that has the permission set in level. This field translates to a `principal` field in secret scope ACL.", - "$ref": "#/$defs/string", - "x-since-version": "v0.252.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.SecretScopePermissionLevel": { - "type": "string", - "enum": [ - "READ", - "WRITE", - "MANAGE" - ] - }, - "resources.SqlWarehouse": { - "type": "object", - "description": "Creates a new SQL warehouse.", - "properties": { - "auto_stop_mins": { - "description": "The amount of time in minutes that a SQL warehouse must be idle (i.e., no\nRUNNING queries) before it is automatically stopped.\n\nSupported values:\n- Must be == 0 or \u003e= 10 mins\n- 0 indicates no autostop.\n\nDefaults to 120 mins", - "$ref": "#/$defs/int", - "x-since-version": "v0.260.0" - }, - "channel": { - "description": "Channel Details", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Channel", - "x-since-version": "v0.260.0" - }, - "cluster_size": { - "description": "Size of the clusters allocated for this warehouse.\nIncreasing the size of a spark cluster allows you to run larger queries on\nit. If you want to increase the number of concurrent queries, please tune\nmax_num_clusters.\n\nSupported values:\n- 2X-Small\n- X-Small\n- Small\n- Medium\n- Large\n- X-Large\n- 2X-Large\n- 3X-Large\n- 4X-Large\n- 5X-Large\n- Auto", - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "creator_name": { - "description": "warehouse creator name", - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "enable_photon": { - "description": "Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to true.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.260.0" - }, - "enable_serverless_compute": { - "description": "Configures whether the warehouse should use serverless compute", - "$ref": "#/$defs/bool", - "x-since-version": "v0.260.0" - }, - "instance_profile_arn": { - "description": "Deprecated. Instance profile used to pass IAM role to the cluster", - "$ref": "#/$defs/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.260.0", - "deprecated": true - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", - "x-since-version": "v0.268.0" - }, - "max_num_clusters": { - "description": "Maximum number of clusters that the autoscaler will create to handle\nconcurrent queries.\n\nSupported values:\n- Must be \u003e= min_num_clusters\n- Must be \u003c= 40.\n\nDefaults to min_clusters if unset.", - "$ref": "#/$defs/int", - "x-since-version": "v0.260.0" - }, - "min_num_clusters": { - "description": "Minimum number of available clusters that will be maintained for this SQL\nwarehouse. Increasing this will ensure that a larger number of clusters are\nalways running and therefore may reduce the cold start time for new\nqueries. This is similar to reserved vs. revocable cores in a resource\nmanager.\n\nSupported values:\n- Must be \u003e 0\n- Must be \u003c= min(max_num_clusters, 30)\n\nDefaults to 1", - "$ref": "#/$defs/int", - "x-since-version": "v0.260.0" - }, - "name": { - "description": "Logical name for the cluster.\n\nSupported values:\n- Must be unique within an org.\n- Must be less than 100 characters.", - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.SqlWarehousePermission", - "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" - }, - "tags": { - "description": "A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated\nwith this SQL warehouse.\n\nSupported values:\n- Number of tags \u003c 45.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.EndpointTags", - "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" - } - }, - "additionalProperties": false - }, - "resources.SqlWarehousePermission": { - "type": "object", - "properties": { - "group_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "level": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.WarehousePermissionLevel", - "x-since-version": "v0.260.0" - }, - "service_principal_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "user_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - } - }, - "additionalProperties": false, - "required": [ - "level" - ] - }, - "resources.SyncedDatabaseTable": { - "type": "object", - "properties": { - "database_instance_name": { - "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" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "logical_database_name": { - "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] Full three-part (catalog, schema, table) name of the table.", - "$ref": "#/$defs/string", - "x-since-version": "v0.266.0" - }, - "spec": { - "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" - } - }, - "additionalProperties": false, - "required": [ - "name" - ] - }, - "resources.VectorSearchEndpoint": { - "type": "object", - "properties": { - "budget_policy_id": { - "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" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.298.0" - }, - "name": { - "description": "Name of the AI Search endpoint", - "$ref": "#/$defs/string", - "x-since-version": "v0.298.0" - }, - "permissions": { - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", - "x-since-version": "v0.298.0" - }, - "target_qps": { - "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] 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, - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false, - "required": [ - "endpoint_type", - "name" - ] - }, - "resources.VectorSearchIndex": { - "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" - }, - "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", - "x-since-version": "v1.1.0" - }, - "index_subtype": { - "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" - }, - "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "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" - } - }, - "additionalProperties": false, - "required": [ - "endpoint_name", - "index_type", - "name", - "primary_key" - ] - }, - "resources.Volume": { - "type": "object", - "properties": { - "catalog_name": { - "description": "The name of the catalog where the schema and the volume are", - "$ref": "#/$defs/string", - "x-since-version": "v0.236.0" - }, - "comment": { - "description": "The comment attached to the volume", - "$ref": "#/$defs/string", - "x-since-version": "v0.236.0" - }, - "grants": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", - "x-since-version": "v0.236.0" - }, - "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.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", - "x-since-version": "v0.268.0" - }, - "name": { - "description": "The name of the volume", - "$ref": "#/$defs/string", - "x-since-version": "v0.236.0" - }, - "schema_name": { - "description": "The name of the schema where the volume is", - "$ref": "#/$defs/string", - "x-since-version": "v0.236.0" - }, - "storage_location": { - "description": "The storage location on the cloud", - "$ref": "#/$defs/string", - "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" - } - }, - "additionalProperties": false, - "required": [ - "catalog_name", - "name", - "schema_name" - ], - "markdownDescription": "The volume resource type allows you to define and create Unity Catalog [volumes](https://docs.databricks.com/api/workspace/volumes/create) as part of a bundle. When deploying a bundle with a volume defined, note that:\n\n- A volume cannot be referenced in the `artifact_path` for the bundle until it exists in the workspace. Hence, if you want to use Declarative Automation Bundles to create the volume, you must first define the volume in the bundle, deploy it to create the volume, then reference it in the `artifact_path` in subsequent deployments.\n\n- Volumes in the bundle are not prepended with the `dev_${workspace.current_user.short_name}` prefix when the deployment target has `mode: development` configured. However, you can manually configure this prefix. See [custom-presets](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html#custom-presets)." - }, - "variable.Lookup": { - "type": "object", - "properties": { - "alert": { - "description": "The name of the alert for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "cluster": { - "description": "The name of the cluster for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "cluster_policy": { - "description": "The name of the cluster_policy for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "dashboard": { - "description": "The name of the dashboard for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "instance_pool": { - "description": "The name of the instance_pool for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "job": { - "description": "The name of the job for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "metastore": { - "description": "The name of the metastore for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "notification_destination": { - "description": "The name of the notification_destination for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.236.0" - }, - "pipeline": { - "description": "The name of the pipeline for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "query": { - "description": "The name of the query for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "service_principal": { - "description": "The name of the service_principal for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "warehouse": { - "description": "The name of the warehouse for which to retrieve an ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "variable.TargetVariable": { - "type": "object", - "properties": { - "default": { - "description": "The default value for the variable.", - "$ref": "#/$defs/interface", - "x-since-version": "v0.229.0" - }, - "description": { - "description": "The description of the variable.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "lookup": { - "description": "The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup", - "x-since-version": "v0.229.0" - }, - "type": { - "description": "The type of the variable.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "variable.Variable": { - "type": "object", - "description": "Defines a custom variable for the bundle.", - "properties": { - "default": { - "description": "The default value for the variable.", - "$ref": "#/$defs/interface", - "x-since-version": "v0.229.0" - }, - "description": { - "description": "The description of the variable", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "lookup": { - "description": "The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup", - "markdownDescription": "The name of the `alert`, `cluster_policy`, `cluster`, `dashboard`, `instance_pool`, `job`, `metastore`, `pipeline`, `query`, `service_principal`, or `warehouse` object for which to retrieve an ID.", - "x-since-version": "v0.229.0" - }, - "type": { - "description": "The type of the variable.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "markdownDescription": "Defines a custom variable for the bundle. See [variables](https://docs.databricks.com/dev-tools/bundles/settings.html#variables)." - }, - "variable.VariableType": { - "type": "string" - } - }, - "config.Artifact": { - "type": "object", - "properties": { - "build": { - "description": "An optional set of build commands to run locally before deployment.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "dynamic_version": { - "description": "Whether to patch the wheel version dynamically based on the timestamp of the whl file. If this is set to `true`, new code can be deployed without having to update the version in `setup.py` or `pyproject.toml`. This setting is only valid when `type` is set to `whl`. See [\\_](/dev-tools/bundles/settings.md#bundle-syntax-mappings-artifacts).", - "$ref": "#/$defs/bool", - "x-since-version": "v0.245.0" - }, - "executable": { - "description": "The executable type. Valid values are `bash`, `sh`, and `cmd`.", - "$ref": "#/$defs/github.com/databricks/cli/libs/exec.ExecutableType", - "x-since-version": "v0.229.0" - }, - "files": { - "description": "The relative or absolute path to the built artifact files.", - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config.ArtifactFile", - "x-since-version": "v0.229.0" - }, - "path": { - "description": "The local path of the directory for the artifact.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "type": { - "description": "Required if the artifact is a Python wheel. The type of the artifact. Valid values are `whl` and `jar`.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.ArtifactType", - "markdownDescription": "Required if the artifact is a Python wheel. The type of the artifact. Valid values are `whl` and `jar`.", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "config.ArtifactFile": { - "type": "object", - "properties": { - "source": { - "description": "Required. The artifact source file.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "source" - ] - }, - "config.ArtifactType": { - "type": "string" - }, - "config.Bundle": { - "type": "object", - "properties": { - "cluster_id": { - "description": "The ID of a cluster to use to run the bundle.", - "$ref": "#/$defs/string", - "markdownDescription": "The ID of a cluster to use to run the bundle. See [cluster_id](https://docs.databricks.com/dev-tools/bundles/settings.html#cluster_id).", - "x-since-version": "v0.229.0" - }, - "compute_id": { - "description": "Deprecated. The ID of the compute to use to run the bundle.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "databricks_cli_version": { - "description": "The Databricks CLI version to use for the bundle.", - "$ref": "#/$defs/string", - "markdownDescription": "The Databricks CLI version to use for the bundle. See [databricks_cli_version](https://docs.databricks.com/dev-tools/bundles/settings.html#databricks_cli_version).", - "x-since-version": "v0.229.0" - }, - "deployment": { - "description": "The definition of the bundle deployment", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Deployment", - "markdownDescription": "The definition of the bundle deployment. For supported attributes see [link](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html).", - "x-since-version": "v0.229.0" - }, - "engine": { - "description": "The deployment engine to use. Valid values are `terraform` and `direct`. Takes priority over `DATABRICKS_BUNDLE_ENGINE` environment variable. Default is \"terraform\".", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/engine.EngineType", - "x-since-version": "v0.295.0" - }, - "git": { - "description": "The Git version control details that are associated with your bundle.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Git", - "markdownDescription": "The Git version control details that are associated with your bundle. For supported attributes see [git](https://docs.databricks.com/dev-tools/bundles/settings.html#git).", - "x-since-version": "v0.229.0" - }, - "name": { - "description": "The name of the bundle.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "uuid": { - "description": "Reserved. A Universally Unique Identifier (UUID) for the bundle that uniquely identifies the bundle in internal Databricks systems. This is generated when a bundle project is initialized using a Databricks template (using the `databricks bundle init` command).", - "$ref": "#/$defs/string", - "x-since-version": "v0.236.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ] - }, - "config.Command": { - "type": "string" - }, - "config.Deployment": { - "type": "object", - "properties": { - "fail_on_active_runs": { - "description": "Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "lock": { - "description": "The deployment lock attributes.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Lock", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "config.Experimental": { - "type": "object", - "properties": { - "pydabs": { - "description": "The PyDABs configuration.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.PyDABs", - "deprecationMessage": "Deprecated: please use python instead", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "python": { - "description": "Configures loading of Python code defined with 'databricks-bundles' package.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Python", - "x-since-version": "v0.238.0" - }, - "python_wheel_wrapper": { - "description": "Whether to use a Python wheel wrapper.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "record_deployment_history": { - "description": "Whether to record deployment history using the deployment metadata service (DMS), which tracks what changed across deployments.", - "$ref": "#/$defs/bool", - "x-since-version": "v1.2.0" - }, - "scripts": { - "description": "The commands to run.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Command", - "x-since-version": "v0.229.0" - }, - "skip_artifact_cleanup": { - "description": "Determines whether to skip cleaning up the .internal folder", - "$ref": "#/$defs/bool", - "x-since-version": "v0.254.0" - }, - "skip_name_prefix_for_schema": { - "description": "Skip adding the prefix that is either set in `presets.name_prefix` or computed when `mode: development`\nis set, to the names of UC schemas defined in the bundle.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.255.0" - }, - "use_legacy_run_as": { - "description": "Whether to use the legacy run_as behavior.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "config.Git": { - "type": "object", - "properties": { - "branch": { - "description": "The Git branch name.", - "$ref": "#/$defs/string", - "markdownDescription": "The Git branch name. See [git](https://docs.databricks.com/dev-tools/bundles/settings.html#git).", - "x-since-version": "v0.229.0" - }, - "origin_url": { - "description": "The origin URL of the repository.", - "$ref": "#/$defs/string", - "markdownDescription": "The origin URL of the repository. See [git](https://docs.databricks.com/dev-tools/bundles/settings.html#git).", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "config.Lock": { - "type": "object", - "properties": { - "enabled": { - "description": "Whether this lock is enabled.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "force": { - "description": "Whether to force this lock if it is enabled.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "config.Mode": { - "type": "string" - }, - "config.Presets": { - "type": "object", - "properties": { - "artifacts_dynamic_version": { - "description": "Whether to enable dynamic_version on all artifacts.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.256.0" - }, - "jobs_max_concurrent_runs": { - "description": "The maximum concurrent runs for a job.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "name_prefix": { - "description": "The prefix for job runs of the bundle.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "pipelines_development": { - "description": "Whether pipeline deployments should be locked in development mode.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "source_linked_deployment": { - "description": "Whether to link the deployment to the bundle source.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.236.0" - }, - "tags": { - "description": "The tags for the bundle deployment.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "trigger_pause_status": { - "description": "A pause status to apply to all job triggers and schedules. Valid values are PAUSED or UNPAUSED.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "config.PyDABs": { - "type": "object", - "properties": { - "enabled": { - "description": "Whether or not PyDABs (Private Preview) is enabled", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "config.Python": { - "type": "object", - "properties": { - "mutators": { - "description": "Mutators contains a list of fully qualified function paths to mutator functions.\n\nExample: [\"my_project.mutators:add_default_cluster\"]", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.238.0" - }, - "resources": { - "description": "Resources contains a list of fully qualified function paths to load resources\ndefined in Python code.\n\nExample: [\"my_project.resources:load_resources\"]", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.238.0" - }, - "venv_path": { - "description": "VEnvPath is path to the virtual environment.\n\nIf enabled, Python code will execute within this environment. If disabled,\nit defaults to using the Python interpreter available in the current shell.", - "$ref": "#/$defs/string", - "x-since-version": "v0.238.0" - } - }, - "additionalProperties": false - }, - "config.Resources": { - "type": "object", - "properties": { - "alerts": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Alert", - "x-since-version": "v0.279.0" - }, - "apps": { - "description": "The app resource defines a Databricks app.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.App", - "markdownDescription": "The app resource defines a [Databricks app](https://docs.databricks.com/api/workspace/apps/create). For information about Databricks Apps, see [link](https://docs.databricks.com/dev-tools/databricks-apps/index.html).", - "x-since-version": "v0.239.0" - }, - "catalogs": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Catalog", - "x-since-version": "v0.287.0" - }, - "clusters": { - "description": "The cluster definitions for the bundle, where each key is the name of a cluster.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Cluster", - "markdownDescription": "The cluster definitions for the bundle, where each key is the name of a cluster. See [clusters](https://docs.databricks.com/dev-tools/bundles/resources.html#clusters).", - "x-since-version": "v0.229.0" - }, - "dashboards": { - "description": "The dashboard definitions for the bundle, where each key is the name of the dashboard.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Dashboard", - "markdownDescription": "The dashboard definitions for the bundle, where each key is the name of the dashboard. See [dashboards](https://docs.databricks.com/dev-tools/bundles/resources.html#dashboards).", - "x-since-version": "v0.232.0" - }, - "database_catalogs": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.DatabaseCatalog", - "x-since-version": "v0.265.0" - }, - "database_instances": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.DatabaseInstance", - "x-since-version": "v0.265.0" - }, - "experiments": { - "description": "The experiment definitions for the bundle, where each key is the name of the experiment.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowExperiment", - "markdownDescription": "The experiment definitions for the bundle, where each key is the name of the experiment. See [experiments](https://docs.databricks.com/dev-tools/bundles/resources.html#experiments).", - "x-since-version": "v0.229.0" - }, - "external_locations": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ExternalLocation", - "x-since-version": "v0.289.0" - }, - "genie_spaces": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.GenieSpace", - "x-since-version": "v1.3.0" - }, - "jobs": { - "description": "The job definitions for the bundle, where each key is the name of the job.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Job", - "markdownDescription": "The job definitions for the bundle, where each key is the name of the job. See [jobs](https://docs.databricks.com/dev-tools/bundles/resources.html#jobs).", - "x-since-version": "v0.229.0" - }, - "model_serving_endpoints": { - "description": "The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint", - "markdownDescription": "The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [model_serving_endpoints](https://docs.databricks.com/dev-tools/bundles/resources.html#model_serving_endpoints).", - "x-since-version": "v0.229.0" - }, - "models": { - "description": "The model definitions for the bundle, where each key is the name of the model.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MlflowModel", - "markdownDescription": "The model definitions for the bundle, where each key is the name of the model. See [models](https://docs.databricks.com/dev-tools/bundles/resources.html#models).", - "x-since-version": "v0.229.0" - }, - "pipelines": { - "description": "The pipeline definitions for the bundle, where each key is the name of the pipeline.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Pipeline", - "markdownDescription": "The pipeline definitions for the bundle, where each key is the name of the pipeline. See [pipelines](https://docs.databricks.com/dev-tools/bundles/resources.html#pipelines).", - "x-since-version": "v0.229.0" - }, - "postgres_branches": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresBranch", - "x-since-version": "v0.287.0" - }, - "postgres_catalogs": { - "description": "The Postgres catalog definitions for the bundle, where each key is the name of the catalog. Each entry binds a Unity Catalog catalog to a Postgres database on a Lakebase Autoscaling branch.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresCatalog", - "x-since-version": "v1.0.0" - }, - "postgres_databases": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresDatabase", - "x-since-version": "v1.4.0" - }, - "postgres_endpoints": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresEndpoint", - "x-since-version": "v0.287.0" - }, - "postgres_projects": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresProject", - "x-since-version": "v0.287.0" - }, - "postgres_roles": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresRole", - "x-since-version": "v1.4.0" - }, - "postgres_synced_tables": { - "description": "The Postgres synced table definitions for the bundle, where each key is the name of the synced table. Each entry continuously replicates a Unity Catalog Delta source table into a Postgres table on a Lakebase Autoscaling instance.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresSyncedTable", - "x-since-version": "v1.0.0" - }, - "quality_monitors": { - "description": "The quality monitor definitions for the bundle, where each key is the name of the quality monitor.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.QualityMonitor", - "markdownDescription": "The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [quality_monitors](https://docs.databricks.com/dev-tools/bundles/resources.html#quality_monitors).", - "x-since-version": "v0.229.0" - }, - "registered_models": { - "description": "The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.RegisteredModel", - "markdownDescription": "The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model. See [registered_models](https://docs.databricks.com/dev-tools/bundles/resources.html#registered_models)", - "x-since-version": "v0.229.0" - }, - "schemas": { - "description": "The schema definitions for the bundle, where each key is the name of the schema.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Schema", - "markdownDescription": "The schema definitions for the bundle, where each key is the name of the schema. See [schemas](https://docs.databricks.com/dev-tools/bundles/resources.html#schemas).", - "x-since-version": "v0.229.0" - }, - "secret_scopes": { - "description": "The secret scope definitions for the bundle, where each key is the name of the secret scope.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.SecretScope", - "markdownDescription": "The secret scope definitions for the bundle, where each key is the name of the secret scope. See [secret_scopes](https://docs.databricks.com/dev-tools/bundles/resources.html#secret_scopes).", - "x-since-version": "v0.252.0" - }, - "sql_warehouses": { - "description": "The SQL warehouse definitions for the bundle, where each key is the name of the warehouse.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.SqlWarehouse", - "markdownDescription": "The SQL warehouse definitions for the bundle, where each key is the name of the warehouse. See [sql_warehouses](https://docs.databricks.com/dev-tools/bundles/resources.html#sql_warehouses).", - "x-since-version": "v0.260.0" - }, - "synced_database_tables": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable", - "x-since-version": "v0.266.0" - }, - "vector_search_endpoints": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.VectorSearchEndpoint", - "x-since-version": "v0.298.0" - }, - "vector_search_indexes": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.VectorSearchIndex", - "x-since-version": "v1.1.0" - }, - "volumes": { - "description": "The volume definitions for the bundle, where each key is the name of the volume.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Volume", - "markdownDescription": "The volume definitions for the bundle, where each key is the name of the volume. See [volumes](https://docs.databricks.com/dev-tools/bundles/resources.html#volumes).", - "x-since-version": "v0.236.0" - } - }, - "additionalProperties": false - }, - "config.Script": { - "type": "object", - "properties": { - "content": { - "$ref": "#/$defs/string", - "x-since-version": "v0.259.0" - } - }, - "additionalProperties": false, - "required": [ - "content" - ] - }, - "config.Sync": { - "type": "object", - "properties": { - "exclude": { - "description": "A list of files or folders to exclude from the bundle.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "include": { - "description": "A list of files or folders to include in the bundle.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "paths": { - "description": "The local folder paths, which can be outside the bundle root, to synchronize to the workspace when the bundle is deployed.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "config.Target": { - "type": "object", - "properties": { - "artifacts": { - "description": "The artifacts to include in the target deployment.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Artifact", - "x-since-version": "v0.229.0" - }, - "bundle": { - "description": "The bundle attributes when deploying to this target.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle", - "x-since-version": "v0.229.0" - }, - "cluster_id": { - "description": "The ID of the cluster to use for this target.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "compute_id": { - "description": "Deprecated. The ID of the compute to use for this target.", - "$ref": "#/$defs/string", - "deprecationMessage": "Deprecated: please use cluster_id instead", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "default": { - "description": "Whether this target is the default target.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "git": { - "description": "The Git version control settings for the target.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Git", - "x-since-version": "v0.229.0" - }, - "mode": { - "description": "The deployment mode for the target.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Mode", - "markdownDescription": "The deployment mode for the target. Valid values are `development` or `production`. See [link](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html).", - "x-since-version": "v0.229.0" - }, - "permissions": { - "description": "The permissions for deploying and running the bundle in the target.", - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", - "x-since-version": "v0.229.0" - }, - "presets": { - "description": "The deployment presets for the target.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Presets", - "x-since-version": "v0.229.0" - }, - "resources": { - "description": "The resource definitions for the target.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources", - "x-since-version": "v0.229.0" - }, - "run_as": { - "description": "The identity to use to run the bundle.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs", - "markdownDescription": "The identity to use to run the bundle, see [link](https://docs.databricks.com/dev-tools/bundles/run-as.html).", - "x-since-version": "v0.229.0" - }, - "sync": { - "description": "The local paths to sync to the target workspace when a bundle is run or deployed.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Sync", - "x-since-version": "v0.229.0" - }, - "variables": { - "description": "The custom variable definitions for the target.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/variable.TargetVariable", - "x-since-version": "v0.229.0" - }, - "workspace": { - "description": "The Databricks workspace for the target.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Workspace", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "config.Workspace": { - "type": "object", - "properties": { - "account_id": { - "description": "The Databricks account ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.296.0" - }, - "artifact_path": { - "description": "The artifact path to use within the workspace for both deployments and job runs", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "auth_type": { - "description": "The authentication type.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "azure_client_id": { - "description": "The Azure client ID", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "azure_environment": { - "description": "The Azure environment", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "azure_login_app_id": { - "description": "The Azure login app ID", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "azure_tenant_id": { - "description": "The Azure tenant ID", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "azure_use_msi": { - "description": "Whether to use MSI for Azure", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "azure_workspace_resource_id": { - "description": "The Azure workspace resource ID", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "client_id": { - "description": "The client ID for the workspace", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "experimental_is_unified_host": { - "description": "Deprecated: no-op. Unified hosts are now detected automatically from /.well-known/databricks-config. Retained for schema compatibility with existing databricks.yml files.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.285.0" - }, - "file_path": { - "description": "The file path to use within the workspace for both deployments and job runs", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "google_service_account": { - "description": "The Google service account name", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "host": { - "description": "The Databricks workspace host URL", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "profile": { - "description": "The Databricks workspace profile name", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "resource_path": { - "description": "The workspace resource path", - "$ref": "#/$defs/string", - "x-since-version": "v0.230.0" - }, - "root_path": { - "description": "The Databricks workspace root path", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "state_path": { - "description": "The workspace state path", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "workspace_id": { - "description": "The Databricks workspace ID", - "$ref": "#/$defs/string", - "x-since-version": "v0.285.0" - } - }, - "additionalProperties": false - } - }, - "libs": { - "exec.ExecutableType": { - "type": "string" - } - } - }, - "databricks-sdk-go": { - "common": { - "types": { - "duration.Duration": { - "type": "string" - }, - "time.Time": { - "type": "object", - "additionalProperties": false - } - } - }, - "service": { - "apps.AppDeployment": { - "type": "object", - "properties": { - "command": { - "description": "The command with which to run the app. This will override the command specified in the app.yaml file.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.283.0" - }, - "deployment_id": { - "description": "The unique id of the deployment.", - "$ref": "#/$defs/string", - "x-since-version": "v0.239.0" - }, - "env_vars": { - "description": "The environment variables to set in the app runtime environment. This will override the environment variables specified in the app.yaml file.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.EnvVar", - "x-since-version": "v0.283.0" - }, - "git_source": { - "description": "Git repository to use as the source for the app deployment.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitSource", - "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" - } - }, - "additionalProperties": false - }, - "apps.AppDeploymentArtifacts": { - "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" - } - }, - "additionalProperties": false - }, - "apps.AppDeploymentMode": { - "type": "string", - "enum": [ - "SNAPSHOT", - "AUTO_SYNC" - ] - }, - "apps.AppDeploymentState": { - "type": "string", - "enum": [ - "SUCCEEDED", - "FAILED", - "IN_PROGRESS", - "CANCELLED" - ] - }, - "apps.AppDeploymentStatus": { - "type": "object", - "additionalProperties": false - }, - "apps.AppPermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "CAN_USE" - ] - }, - "apps.AppResource": { - "type": "object", - "properties": { - "app": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceApp", - "x-since-version": "v0.290.0" - }, - "database": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceDatabase", - "x-since-version": "v0.260.0" - }, - "description": { - "description": "Description of the App Resource.", - "$ref": "#/$defs/string", - "x-since-version": "v0.239.0" - }, - "experiment": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceExperiment", - "x-since-version": "v0.283.0" - }, - "genie_space": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceGenieSpace", - "x-since-version": "v0.273.0" - }, - "job": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJob", - "x-since-version": "v0.239.0" - }, - "name": { - "description": "Name of the App Resource.", - "$ref": "#/$defs/string", - "x-since-version": "v0.239.0" - }, - "postgres": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourcePostgres", - "x-since-version": "v0.294.0" - }, - "secret": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecret", - "x-since-version": "v0.239.0" - }, - "serving_endpoint": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpoint", - "x-since-version": "v0.239.0" - }, - "sql_warehouse": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouse", - "x-since-version": "v0.239.0" - }, - "uc_securable": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurable", - "x-since-version": "v0.253.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ] - }, - "apps.AppResourceApp": { - "type": "object", - "properties": { - "name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.298.0" - }, - "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceAppAppPermission", - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false - }, - "apps.AppResourceAppAppPermission": { - "type": "string", - "enum": [ - "CAN_USE" - ] - }, - "apps.AppResourceDatabase": { - "type": "object", - "properties": { - "database_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "instance_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceDatabaseDatabasePermission", - "x-since-version": "v0.260.0" - } - }, - "additionalProperties": false, - "required": [ - "database_name", - "instance_name", - "permission" - ] - }, - "apps.AppResourceDatabaseDatabasePermission": { - "type": "string", - "enum": [ - "CAN_CONNECT_AND_CREATE" - ] - }, - "apps.AppResourceExperiment": { - "type": "object", - "properties": { - "experiment_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceExperimentExperimentPermission", - "x-since-version": "v0.283.0" - } - }, - "additionalProperties": false, - "required": [ - "experiment_id", - "permission" - ] - }, - "apps.AppResourceExperimentExperimentPermission": { - "type": "string", - "enum": [ - "CAN_MANAGE", - "CAN_EDIT", - "CAN_READ" - ] - }, - "apps.AppResourceGenieSpace": { - "type": "object", - "properties": { - "name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.273.0" - }, - "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceGenieSpaceGenieSpacePermission", - "x-since-version": "v0.273.0" - }, - "space_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.273.0" - } - }, - "additionalProperties": false, - "required": [ - "name", - "permission", - "space_id" - ] - }, - "apps.AppResourceGenieSpaceGenieSpacePermission": { - "type": "string", - "enum": [ - "CAN_MANAGE", - "CAN_EDIT", - "CAN_RUN", - "CAN_VIEW" - ] - }, - "apps.AppResourceJob": { - "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" - } - }, - "additionalProperties": false, - "required": [ - "id", - "permission" - ] - }, - "apps.AppResourceJobJobPermission": { - "type": "string", - "enum": [ - "CAN_MANAGE", - "IS_OWNER", - "CAN_MANAGE_RUN", - "CAN_VIEW" - ] - }, - "apps.AppResourcePostgres": { - "type": "object", - "properties": { - "branch": { - "$ref": "#/$defs/string", - "x-since-version": "v0.294.0" - }, - "database": { - "$ref": "#/$defs/string", - "x-since-version": "v0.294.0" - }, - "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourcePostgresPostgresPermission", - "x-since-version": "v0.294.0" - } - }, - "additionalProperties": false - }, - "apps.AppResourcePostgresPostgresPermission": { - "type": "string", - "enum": [ - "CAN_CONNECT_AND_CREATE" - ] - }, - "apps.AppResourceSecret": { - "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" - } - }, - "additionalProperties": false, - "required": [ - "key", - "permission", - "scope" - ] - }, - "apps.AppResourceSecretSecretPermission": { - "type": "string", - "description": "Permission to grant on the secret scope. Supported permissions are: \"READ\", \"WRITE\", \"MANAGE\".", - "enum": [ - "READ", - "WRITE", - "MANAGE" - ] - }, - "apps.AppResourceServingEndpoint": { - "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" - } - }, - "additionalProperties": false, - "required": [ - "name", - "permission" - ] - }, - "apps.AppResourceServingEndpointServingEndpointPermission": { - "type": "string", - "enum": [ - "CAN_MANAGE", - "CAN_QUERY", - "CAN_VIEW" - ] - }, - "apps.AppResourceSqlWarehouse": { - "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" - } - }, - "additionalProperties": false, - "required": [ - "id", - "permission" - ] - }, - "apps.AppResourceSqlWarehouseSqlWarehousePermission": { - "type": "string", - "enum": [ - "CAN_MANAGE", - "CAN_USE", - "IS_OWNER" - ] - }, - "apps.AppResourceUcSecurable": { - "type": "object", - "properties": { - "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurableUcSecurablePermission", - "x-since-version": "v0.253.0" - }, - "securable_full_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.253.0" - }, - "securable_type": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurableUcSecurableType", - "x-since-version": "v0.253.0" - } - }, - "additionalProperties": false, - "required": [ - "permission", - "securable_full_name", - "securable_type" - ] - }, - "apps.AppResourceUcSecurableUcSecurablePermission": { - "type": "string", - "enum": [ - "READ_VOLUME", - "WRITE_VOLUME", - "SELECT", - "EXECUTE", - "USE_CONNECTION", - "MODIFY" - ] - }, - "apps.AppResourceUcSecurableUcSecurableType": { - "type": "string", - "enum": [ - "VOLUME", - "TABLE", - "FUNCTION", - "CONNECTION" - ] - }, - "apps.ApplicationState": { - "type": "string", - "enum": [ - "DEPLOYING", - "RUNNING", - "CRASHED", - "UNAVAILABLE" - ] - }, - "apps.ApplicationStatus": { - "type": "object", - "additionalProperties": false - }, - "apps.ComputeSize": { - "type": "string", - "enum": [ - "MEDIUM", - "LARGE" - ] - }, - "apps.ComputeState": { - "type": "string", - "enum": [ - "ERROR", - "DELETING", - "STARTING", - "STOPPING", - "UPDATING", - "STOPPED", - "ACTIVE" - ] - }, - "apps.ComputeStatus": { - "type": "object", - "additionalProperties": false - }, - "apps.EnvVar": { - "type": "object", - "properties": { - "name": { - "description": "The name of the environment variable.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "value": { - "description": "The value for the environment variable.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "value_from": { - "description": "The name of an external Databricks resource that contains the value, such as a secret or a database table.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - } - }, - "additionalProperties": false - }, - "apps.GitRepository": { - "type": "object", - "description": "Git repository configuration specifying the location of the repository.", - "properties": { - "provider": { - "description": "Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud,\nbitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "url": { - "description": "URL of the Git repository.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - } - }, - "additionalProperties": false, - "required": [ - "provider", - "url" - ] - }, - "apps.GitSource": { - "type": "object", - "description": "Complete git source specification including repository location and reference.", - "properties": { - "branch": { - "description": "Git branch to checkout.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "commit": { - "description": "Git commit SHA to checkout.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "source_code_path": { - "description": "Relative path to the app source code within the Git repository. If not specified, the root\nof the repository is used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "tag": { - "description": "Git tag to checkout.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - } - }, - "additionalProperties": false - }, - "apps.TelemetryExportDestination": { - "type": "object", - "description": "A single telemetry export destination with its configuration and status.", - "properties": { - "unity_catalog": { - "description": "[Public Preview] Unity Catalog Destinations for OTEL telemetry export.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.UnityCatalog", - "x-since-version": "v0.294.0" - } - }, - "additionalProperties": false - }, - "apps.UnityCatalog": { - "type": "object", - "description": "Unity Catalog Destinations for OTEL telemetry export.", - "properties": { - "logs_table": { - "description": "[Public Preview] Unity Catalog table for OTEL logs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.294.0" - }, - "metrics_table": { - "description": "[Public Preview] Unity Catalog table for OTEL metrics.", - "$ref": "#/$defs/string", - "x-since-version": "v0.294.0" - }, - "traces_table": { - "description": "[Public Preview] Unity Catalog table for OTEL traces (spans).", - "$ref": "#/$defs/string", - "x-since-version": "v0.294.0" - } - }, - "additionalProperties": false, - "required": [ - "logs_table", - "metrics_table", - "traces_table" - ] - }, - "catalog.AwsSqsQueue": { - "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" - } - }, - "additionalProperties": false - }, - "catalog.AzureEncryptionSettings": { - "type": "object", - "properties": { - "azure_cmk_access_connector_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.298.0" - }, - "azure_cmk_managed_identity_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.298.0" - }, - "azure_tenant_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false, - "required": [ - "azure_tenant_id" - ] - }, - "catalog.AzureQueueStorage": { - "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" - } - }, - "additionalProperties": false - }, - "catalog.EncryptionDetails": { - "type": "object", - "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" - } - }, - "additionalProperties": false - }, - "catalog.EncryptionSettings": { - "type": "object", - "description": "Encryption Settings are used to carry metadata for securable encryption at rest.\nCurrently used for catalogs, we can use the information supplied here to interact with a CMK.", - "properties": { - "azure_encryption_settings": { - "description": "optional Azure settings - only required if an Azure CMK is used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureEncryptionSettings", - "x-since-version": "v0.298.0" - }, - "azure_key_vault_key_id": { - "description": "the AKV URL in Azure, null otherwise.", - "$ref": "#/$defs/string", - "x-since-version": "v0.298.0" - }, - "customer_managed_key_id": { - "description": "the CMK uuid in AWS and GCP, null otherwise.", - "$ref": "#/$defs/string", - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false - }, - "catalog.FileEventQueue": { - "type": "object", - "properties": { - "managed_aqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage", - "x-since-version": "v0.289.0" - }, - "managed_pubsub": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", - "x-since-version": "v0.289.0" - }, - "managed_sqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", - "x-since-version": "v0.289.0" - }, - "provided_aqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage", - "x-since-version": "v0.289.0" - }, - "provided_pubsub": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", - "x-since-version": "v0.289.0" - }, - "provided_sqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", - "x-since-version": "v0.289.0" - } - }, - "additionalProperties": false - }, - "catalog.GcpPubsub": { - "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" - } - }, - "additionalProperties": false - }, - "catalog.MonitorCronSchedule": { - "type": "object", - "properties": { - "pause_status": { - "description": "Read only field that indicates whether a schedule is paused or not.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorCronSchedulePauseStatus", - "x-since-version": "v0.229.0" - }, - "quartz_cron_expression": { - "description": "The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html).", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "timezone_id": { - "description": "The timezone id (e.g., ``PST``) in which to evaluate the quartz expression.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "quartz_cron_expression", - "timezone_id" - ] - }, - "catalog.MonitorCronSchedulePauseStatus": { - "type": "string", - "description": "Source link: https://src.dev.databricks.com/databricks/universe/-/blob/elastic-spark-common/api/messages/schedule.proto\nMonitoring workflow schedule pause status.", - "enum": [ - "UNSPECIFIED", - "UNPAUSED", - "PAUSED" - ] - }, - "catalog.MonitorDataClassificationConfig": { - "type": "object", - "description": "Data classification related configuration.", - "properties": { - "enabled": { - "description": "[Private Preview] Whether to enable data classification.", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "catalog.MonitorDestination": { - "type": "object", - "properties": { - "email_addresses": { - "description": "The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "catalog.MonitorInferenceLog": { - "type": "object", - "properties": { - "granularities": { - "description": "Granularities for aggregating data into time windows based on their timestamp. Valid values are 5 minutes, 30 minutes, 1 hour, 1 day, n weeks, 1 month, or 1 year.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "label_col": { - "description": "Column for the label.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "model_id_col": { - "description": "Column for the model identifier.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "prediction_col": { - "description": "Column for the prediction.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "prediction_proba_col": { - "description": "Column for prediction probabilities", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "problem_type": { - "description": "Problem type the model aims to solve.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLogProblemType", - "x-since-version": "v0.229.0" - }, - "timestamp_col": { - "description": "Column for the timestamp.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "granularities", - "model_id_col", - "prediction_col", - "problem_type", - "timestamp_col" - ] - }, - "catalog.MonitorInferenceLogProblemType": { - "type": "string", - "enum": [ - "PROBLEM_TYPE_CLASSIFICATION", - "PROBLEM_TYPE_REGRESSION" - ] - }, - "catalog.MonitorMetric": { - "type": "object", - "description": "Custom metric definition.", - "properties": { - "definition": { - "description": "Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition).", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "input_columns": { - "description": "A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "name": { - "description": "Name of the metric in the output tables.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "output_data_type": { - "description": "The output type of the custom metric.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "type": { - "description": "Can only be one of ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"``, ``\"CUSTOM_METRIC_TYPE_DERIVED\"``, or ``\"CUSTOM_METRIC_TYPE_DRIFT\"``.\nThe ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"`` and ``\"CUSTOM_METRIC_TYPE_DERIVED\"`` metrics\nare computed on a single table, whereas the ``\"CUSTOM_METRIC_TYPE_DRIFT\"`` compare metrics across\nbaseline and input table, or across the two consecutive time windows.\n- CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table\n- CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics\n- CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetricType", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "definition", - "input_columns", - "name", - "output_data_type", - "type" - ] - }, - "catalog.MonitorMetricType": { - "type": "string", - "description": "Can only be one of ``\\\"CUSTOM_METRIC_TYPE_AGGREGATE\\\"``, ``\\\"CUSTOM_METRIC_TYPE_DERIVED\\\"``, or ``\\\"CUSTOM_METRIC_TYPE_DRIFT\\\"``.\nThe ``\\\"CUSTOM_METRIC_TYPE_AGGREGATE\\\"`` and ``\\\"CUSTOM_METRIC_TYPE_DERIVED\\\"`` metrics\nare computed on a single table, whereas the ``\\\"CUSTOM_METRIC_TYPE_DRIFT\\\"`` compare metrics across\nbaseline and input table, or across the two consecutive time windows.\n- CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table\n- CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics\n- CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics", - "enum": [ - "CUSTOM_METRIC_TYPE_AGGREGATE", - "CUSTOM_METRIC_TYPE_DERIVED", - "CUSTOM_METRIC_TYPE_DRIFT" - ] - }, - "catalog.MonitorNotifications": { - "type": "object", - "properties": { - "on_failure": { - "description": "Destinations to send notifications on failure/timeout.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", - "x-since-version": "v0.229.0" - }, - "on_new_classification_tag_detected": { - "description": "[Private Preview] Destinations to send notifications on new classification tag detected.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "catalog.MonitorSnapshot": { - "type": "object", - "description": "Snapshot analysis configuration", - "additionalProperties": false - }, - "catalog.MonitorTimeSeries": { - "type": "object", - "description": "Time series analysis configuration.", - "properties": { - "granularities": { - "description": "Granularities for aggregating data into time windows based on their timestamp. Valid values are 5 minutes, 30 minutes, 1 hour, 1 day, n weeks, 1 month, or 1 year.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "timestamp_col": { - "description": "Column for the timestamp.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "granularities", - "timestamp_col" - ] - }, - "catalog.Privilege": { - "type": "string", - "enum": [ - "SELECT", - "READ_PRIVATE_FILES", - "WRITE_PRIVATE_FILES", - "CREATE", - "USAGE", - "USE_CATALOG", - "USE_SCHEMA", - "CREATE_SCHEMA", - "CREATE_VIEW", - "CREATE_EXTERNAL_TABLE", - "CREATE_MATERIALIZED_VIEW", - "CREATE_FUNCTION", - "CREATE_MODEL", - "CREATE_CATALOG", - "CREATE_MANAGED_STORAGE", - "CREATE_EXTERNAL_LOCATION", - "CREATE_STORAGE_CREDENTIAL", - "CREATE_SERVICE_CREDENTIAL", - "ACCESS", - "CREATE_SHARE", - "CREATE_RECIPIENT", - "CREATE_PROVIDER", - "USE_SHARE", - "USE_RECIPIENT", - "USE_PROVIDER", - "USE_MARKETPLACE_ASSETS", - "SET_SHARE_PERMISSION", - "MODIFY", - "REFRESH", - "EXECUTE", - "READ_FILES", - "WRITE_FILES", - "CREATE_TABLE", - "ALL_PRIVILEGES", - "CREATE_CONNECTION", - "USE_CONNECTION", - "APPLY_TAG", - "CREATE_FOREIGN_CATALOG", - "CREATE_FOREIGN_SECURABLE", - "MANAGE_ALLOWLIST", - "CREATE_VOLUME", - "CREATE_EXTERNAL_VOLUME", - "READ_VOLUME", - "WRITE_VOLUME", - "MANAGE", - "BROWSE", - "CREATE_CLEAN_ROOM", - "MODIFY_CLEAN_ROOM", - "EXECUTE_CLEAN_ROOM_TASK", - "EXTERNAL_USE_SCHEMA" - ] - }, - "catalog.PrivilegeAssignment": { - "type": "object", - "properties": { - "principal": { - "description": "The principal (user email address or group name).\nFor deleted principals, `principal` is empty while `principal_id` is populated.", - "$ref": "#/$defs/string", - "x-since-version": "v0.294.0" - }, - "privileges": { - "description": "The privileges assigned to the principal.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.Privilege", - "x-since-version": "v0.294.0" - } - }, - "additionalProperties": false - }, - "catalog.RegisteredModelAlias": { - "type": "object", - "properties": { - "alias_name": { - "description": "Name of the alias, e.g. 'champion' or 'latest_stable'", - "$ref": "#/$defs/string", - "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" - }, - "version_num": { - "description": "Integer version number of the model version to which this alias points.", - "$ref": "#/$defs/int", - "x-since-version": "v0.273.0" - } - }, - "additionalProperties": false - }, - "catalog.SseEncryptionDetails": { - "type": "object", - "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" - } - }, - "additionalProperties": false - }, - "catalog.SseEncryptionDetailsAlgorithm": { - "type": "string", - "description": "SSE algorithm to use for encrypting S3 objects", - "enum": [ - "AWS_SSE_S3", - "AWS_SSE_KMS", - "AWS_SSE_KMS", - "AWS_SSE_S3" - ] - }, - "catalog.VolumeType": { - "type": "string", - "enum": [ - "MANAGED", - "EXTERNAL" - ] - }, - "compute.Adlsgen2Info": { - "type": "object", - "description": "A storage location in Adls Gen2", - "properties": { - "destination": { - "description": "abfss destination, e.g. `abfss://\u003ccontainer-name\u003e@\u003cstorage-account-name\u003e.dfs.core.windows.net/\u003cdirectory-name\u003e`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "destination" - ] - }, - "compute.AutoScale": { - "type": "object", - "properties": { - "max_workers": { - "description": "The maximum number of workers to which the cluster can scale up when overloaded.\nNote that `max_workers` must be strictly greater than `min_workers`.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "min_workers": { - "description": "The minimum number of workers to which the cluster can scale down when underutilized.\nIt is also the initial number of workers the cluster will have after creation.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.AwsAttributes": { - "type": "object", - "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" - }, - "ebs_volume_count": { - "description": "The number of volumes launched for each instance. Users can choose up to 10 volumes.\nThis feature is only enabled for supported node types. Legacy node types cannot specify\ncustom EBS volumes.\nFor node types with no instance store, at least one EBS volume needs to be specified;\notherwise, cluster creation will fail.\n\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\n\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\nstore volumes.\n\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\nwill be overridden.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "ebs_volume_iops": { - "description": "If using gp3 volumes, what IOPS to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "ebs_volume_size": { - "description": "The size of each EBS volume (in GiB) launched for each instance. For general purpose\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\nthis value must be within the range 500 - 4096.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "ebs_volume_throughput": { - "description": "If using gp3 volumes, what throughput to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used.", - "$ref": "#/$defs/int", - "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" - }, - "first_on_demand": { - "description": "The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "instance_profile_arn": { - "description": "Nodes for this cluster will only be placed on AWS instances with this instance profile. If\nommitted, nodes will be placed on instances without an IAM instance profile. The instance\nprofile must have previously been added to the Databricks environment by an account\nadministrator.\n\nThis feature may only be available to certain customer plans.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "spot_bid_price_percent": { - "description": "The bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "zone_id": { - "description": "Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, the zone \"auto\" will be used.\nIf the zone specified is \"auto\", will try to place cluster in a zone with high availability,\nand will retry placement in a different AZ if there is not enough capacity.\n\nThe list of available zones as well as the default value can be found by using the\n`List Zones` method.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.AwsAvailability": { - "type": "string", - "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.", - "enum": [ - "SPOT", - "ON_DEMAND", - "SPOT_WITH_FALLBACK" - ] - }, - "compute.AzureAttributes": { - "type": "object", - "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" - }, - "capacity_reservation_group": { - "description": "[Public Preview] The Azure capacity reservation group resource ID to use for launching VMs.\nWhen specified, VMs will be launched using the provided capacity reservation.\n\nCapacity reservations can only be specified when the workspace uses injected vnet (i.e. customer defined vnet not\nmanaged by databricks). Ensure the databricks-login-prod Enterprise Application is granted the following four permissions:\n1. Microsoft.Compute/capacityReservationGroups/read\n2. Microsoft.Compute/capacityReservationGroups/deploy/action\n3. Microsoft.Compute/capacityReservationGroups/capacityReservations/read\n4. Microsoft.Compute/capacityReservationGroups/capacityReservations/deploy/action\n\nFormat: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}`", - "$ref": "#/$defs/string" - }, - "first_on_demand": { - "description": "The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "log_analytics_info": { - "description": "Defines values necessary to configure and run Azure Log Analytics agent", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.LogAnalyticsInfo", - "x-since-version": "v0.229.0" - }, - "spot_bid_max_price": { - "description": "The max bid price to be used for Azure spot instances.\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\non the basis of price, and only on the basis of availability. Further, the value should \u003e 0 or -1.", - "$ref": "#/$defs/float64", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.AzureAvailability": { - "type": "string", - "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\nNote: If `first_on_demand` is zero, this availability type will be used for the entire cluster.", - "enum": [ - "SPOT_AZURE", - "ON_DEMAND_AZURE", - "SPOT_WITH_FALLBACK_AZURE" - ] - }, - "compute.ClientsTypes": { - "type": "object", - "properties": { - "jobs": { - "description": "With jobs set, the cluster can be used for jobs", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "notebooks": { - "description": "With notebooks set, this cluster can be used for notebooks", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.ClusterLogConf": { - "type": "object", - "description": "Cluster log delivery config", - "properties": { - "dbfs": { - "description": "destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DbfsStorageInfo", - "x-since-version": "v0.229.0" - }, - "s3": { - "description": "destination and either the region or endpoint need to be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.S3StorageInfo", - "x-since-version": "v0.229.0" - }, - "volumes": { - "description": "destination needs to be provided, e.g.\n`{ \"volumes\": { \"destination\": \"/Volumes/catalog/schema/volume/cluster_log\" } }`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.VolumesStorageInfo", - "x-since-version": "v0.242.0" - } - }, - "additionalProperties": false - }, - "compute.ClusterPermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "CAN_RESTART", - "CAN_ATTACH_TO" - ] - }, - "compute.ClusterSpec": { - "type": "object", - "description": "Contains a snapshot of the latest user specified settings that were used to create/edit the cluster.", - "properties": { - "apply_policy_default_values": { - "description": "When set to true, fixed and default values from the policy will be used for fields that are omitted. When set to false, only fixed values from the policy will be applied.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "autoscale": { - "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AutoScale", - "x-since-version": "v0.229.0" - }, - "autotermination_minutes": { - "description": "Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "aws_attributes": { - "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes", - "x-since-version": "v0.229.0" - }, - "azure_attributes": { - "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes", - "x-since-version": "v0.229.0" - }, - "cluster_log_conf": { - "description": "The configuration for delivering spark logs to a long-term storage destination.\nThree kinds of destinations (DBFS, S3 and Unity Catalog volumes) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf", - "x-since-version": "v0.229.0" - }, - "cluster_name": { - "description": "Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\nFor job clusters, the cluster name is automatically set based on the job and job run IDs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "custom_tags": { - "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", - "$ref": "#/$defs/map/string", - "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" - }, - "driver_instance_pool_id": { - "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "driver_node_type_flexibility": { - "description": "Flexible node type configuration for the driver node.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", - "x-since-version": "v0.285.0" - }, - "driver_node_type_id": { - "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n\nThis field, along with node_type_id, should not be set if virtual_cluster_size is set.\nIf both driver_node_type_id, node_type_id, and virtual_cluster_size are specified, driver_node_type_id and node_type_id take precedence.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "enable_elastic_disk": { - "description": "Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "enable_local_disk_encryption": { - "description": "Whether to enable LUKS on cluster VMs' local disks", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "gcp_attributes": { - "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes", - "x-since-version": "v0.229.0" - }, - "init_scripts": { - "description": "The configuration for storing init scripts. Any number of destinations can be specified.\nThe scripts are executed sequentially in the order provided.\nIf `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo", - "x-since-version": "v0.229.0" - }, - "instance_pool_id": { - "description": "The optional ID of the instance pool to which the cluster belongs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "is_single_node": { - "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\nWhen set to true, Databricks will automatically set single node related `custom_tags`, `spark_conf`, and `num_workers`", - "$ref": "#/$defs/bool", - "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" - }, - "node_type_id": { - "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "num_workers": { - "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "policy_id": { - "description": "The ID of the cluster policy used to create the cluster if applicable.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "remote_disk_throughput": { - "description": "If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED disks.", - "$ref": "#/$defs/int", - "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" - }, - "single_user_name": { - "description": "Single user name if data_security_mode is `SINGLE_USER`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "spark_conf": { - "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "spark_env_vars": { - "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "spark_version": { - "description": "The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "ssh_public_keys": { - "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "total_initial_remote_disk_size": { - "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED disks.", - "$ref": "#/$defs/int", - "x-since-version": "v0.257.0" - }, - "use_ml_runtime": { - "description": "This field can only be used when `kind = CLASSIC_PREVIEW`.\n\n`effective_spark_version` is determined by `spark_version` (DBR release), this field `use_ml_runtime`, and whether `node_type_id` is gpu node or not.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.237.0" - }, - "worker_node_type_flexibility": { - "description": "Flexible node type configuration for worker nodes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", - "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" - } - }, - "additionalProperties": false - }, - "compute.ConfidentialComputeType": { - "type": "string", - "description": "Confidential computing technology for GCP instances.\nAligns with gcloud's --confidential-compute-type flag and the REST API's\nconfidentialInstanceConfig.confidentialInstanceType field.\nSee: https://cloud.google.com/confidential-computing/confidential-vm/docs/create-a-confidential-vm-instance", - "enum": [ - "CONFIDENTIAL_COMPUTE_TYPE_NONE", - "SEV_SNP" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]" - ] - }, - "compute.DataSecurityMode": { - "type": "string", - "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.", - "enum": [ - "NONE", - "SINGLE_USER", - "USER_ISOLATION", - "LEGACY_TABLE_ACL", - "LEGACY_PASSTHROUGH", - "LEGACY_SINGLE_USER", - "LEGACY_SINGLE_USER_STANDARD", - "DATA_SECURITY_MODE_STANDARD", - "DATA_SECURITY_MODE_DEDICATED", - "DATA_SECURITY_MODE_AUTO" - ], - "enumDescriptions": [ - "", - "Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.", - "Legacy alias for `DATA_SECURITY_MODE_STANDARD`.", - "This mode is for users migrating from legacy Table ACL clusters.", - "This mode is for users migrating from legacy Passthrough on high concurrency clusters.", - "This mode is for users migrating from legacy Passthrough on standard clusters.", - "This mode provides a way that doesn’t have UC nor passthrough enabled.", - "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.", - "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.", - "\u003cDatabricks\u003e will choose the most appropriate access mode depending on your compute configuration." - ] - }, - "compute.DbfsStorageInfo": { - "type": "object", - "description": "A storage location in DBFS", - "properties": { - "destination": { - "description": "dbfs destination, e.g. `dbfs:/my/path`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "destination" - ] - }, - "compute.DockerBasicAuth": { - "type": "object", - "properties": { - "password": { - "description": "Password of the user", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "username": { - "description": "Name of the user", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.DockerImage": { - "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" - }, - "url": { - "description": "URL of the docker image.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.EbsVolumeType": { - "type": "string", - "description": "All EBS volume types that Databricks supports.\nSee https://aws.amazon.com/ebs/details/ for details.", - "enum": [ - "GENERAL_PURPOSE_SSD", - "THROUGHPUT_OPTIMIZED_HDD" - ] - }, - "compute.Environment": { - "type": "object", - "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.", - "properties": { - "base_environment": { - "description": "The base environment this environment is built on top of. A base environment defines the environment version and a\nlist of dependencies for serverless compute. The value can be a file path to a custom `env.yaml` file\n(e.g., `/Workspace/path/to/env.yaml`). Support for a Databricks-provided base environment ID\n(e.g., `workspace-base-environments/databricks_ai_v4`) and workspace base environment ID\n(e.g., `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) is in Beta.\nEither `environment_version` or `base_environment` can be provided.\nFor more information about Databricks-provided base environments, see the\n[list workspace base environments](:method:Environments/ListWorkspaceBaseEnvironments) API.\nFor more information, see", - "$ref": "#/$defs/string", - "x-since-version": "v0.289.0" - }, - "client": { - "description": "Use `environment_version` instead.", - "$ref": "#/$defs/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "dependencies": { - "description": "List of pip dependencies, as supported by the version of pip in this environment.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "environment_version": { - "description": "Either `environment_version` or `base_environment` needs to be provided. Environment version used by the environment.\nEach version comes with a specific Python version and a set of Python packages.\nThe version is a string, consisting of an integer.", - "$ref": "#/$defs/string", - "x-since-version": "v0.252.0" - }, - "java_dependencies": { - "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" - } - }, - "additionalProperties": false - }, - "compute.GcpAttributes": { - "type": "object", - "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" - }, - "boot_disk_size": { - "description": "Boot disk size in GB", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "confidential_compute_type": { - "description": "[Private Preview] The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ConfidentialComputeType", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "first_on_demand": { - "description": "The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster.", - "$ref": "#/$defs/int", - "x-since-version": "v0.265.0" - }, - "google_service_account": { - "description": "If provided, the cluster will impersonate the google service account when accessing\ngcloud services (like GCS). The google service account\nmust have previously been added to the Databricks environment by an account\nadministrator.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "local_ssd_count": { - "description": "If provided, each node (workers and driver) in the cluster will have this number of local SSDs attached.\nEach local SSD is 375GB in size.\nRefer to [GCP documentation](https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds)\nfor the supported number of local SSDs for each instance type.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "use_preemptible_executors": { - "description": "This field determines whether the spark executors will be scheduled to run on preemptible\nVMs (when set to true) versus standard compute engine VMs (when set to false; default).\nNote: Soon to be deprecated, use the 'availability' field instead.", - "$ref": "#/$defs/bool", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "zone_id": { - "description": "Identifier for the availability zone in which the cluster resides.\nThis can be one of the following:\n- \"HA\" =\u003e High availability, spread nodes across availability zones for a Databricks deployment region [default].\n- \"AUTO\" =\u003e Databricks picks an availability zone to schedule the cluster on.\n- A GCP availability zone =\u003e Pick One of the available zones for (machine type + region) from\nhttps://cloud.google.com/compute/docs/regions-zones.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.GcpAvailability": { - "type": "string", - "description": "This field determines whether the instance pool will contain preemptible\nVMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.", - "enum": [ - "PREEMPTIBLE_GCP", - "ON_DEMAND_GCP", - "PREEMPTIBLE_WITH_FALLBACK_GCP" - ] - }, - "compute.GcsStorageInfo": { - "type": "object", - "description": "A storage location in Google Cloud Platform's GCS", - "properties": { - "destination": { - "description": "GCS destination/URI, e.g. `gs://my-bucket/some-prefix`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "destination" - ] - }, - "compute.HardwareAcceleratorType": { - "type": "string", - "description": "HardwareAcceleratorType: The type of hardware accelerator to use for compute workloads.\nNOTE: This enum is referenced and is intended to be used by other Databricks services\nthat need to specify hardware accelerator requirements for AI compute workloads.", - "enum": [ - "GPU_1xA10", - "GPU_8xH100" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]" - ] - }, - "compute.InitScriptInfo": { - "type": "object", - "description": "Config for an individual init script\nNext ID: 11", - "properties": { - "abfss": { - "description": "Contains the Azure Data Lake Storage destination path", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Adlsgen2Info", - "x-since-version": "v0.229.0" - }, - "dbfs": { - "description": "destination needs to be provided. e.g.\n`{ \"dbfs\": { \"destination\" : \"dbfs:/home/cluster_log\" } }`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DbfsStorageInfo", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "file": { - "description": "destination needs to be provided, e.g.\n`{ \"file\": { \"destination\": \"file:/my/local/file.sh\" } }`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.LocalFileInfo", - "x-since-version": "v0.229.0" - }, - "gcs": { - "description": "destination needs to be provided, e.g.\n`{ \"gcs\": { \"destination\": \"gs://my-bucket/file.sh\" } }`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcsStorageInfo", - "x-since-version": "v0.229.0" - }, - "s3": { - "description": "destination and either the region or endpoint need to be provided. e.g.\n`{ \\\"s3\\\": { \\\"destination\\\": \\\"s3://cluster_log_bucket/prefix\\\", \\\"region\\\": \\\"us-west-2\\\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.S3StorageInfo", - "x-since-version": "v0.229.0" - }, - "volumes": { - "description": "destination needs to be provided. e.g.\n`{ \\\"volumes\\\" : { \\\"destination\\\" : \\\"/Volumes/my-init.sh\\\" } }`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.VolumesStorageInfo", - "x-since-version": "v0.229.0" - }, - "workspace": { - "description": "destination needs to be provided, e.g.\n`{ \"workspace\": { \"destination\": \"/cluster-init-scripts/setup-datadog.sh\" } }`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkspaceStorageInfo", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.Kind": { - "type": "string", - "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`.", - "enum": [ - "CLASSIC_PREVIEW" - ] - }, - "compute.Library": { - "type": "object", - "properties": { - "cran": { - "description": "Specification of a CRAN library to be installed as part of the library", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RCranLibrary", - "x-since-version": "v0.229.0" - }, - "egg": { - "description": "Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above.", - "$ref": "#/$defs/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "jar": { - "description": "URI of the JAR library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs.\nFor example: `{ \"jar\": \"/Workspace/path/to/library.jar\" }`, `{ \"jar\" : \"/Volumes/path/to/library.jar\" }` or\n`{ \"jar\": \"s3://my-bucket/library.jar\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "maven": { - "description": "Specification of a maven library to be installed. For example:\n`{ \"coordinates\": \"org.jsoup:jsoup:1.7.2\" }`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", - "x-since-version": "v0.229.0" - }, - "pypi": { - "description": "Specification of a PyPi library to be installed. For example:\n`{ \"package\": \"simplejson\" }`", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.PythonPyPiLibrary", - "x-since-version": "v0.229.0" - }, - "requirements": { - "description": "URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes paths are supported.\nFor example: `{ \"requirements\": \"/Workspace/path/to/requirements.txt\" }` or `{ \"requirements\" : \"/Volumes/path/to/requirements.txt\" }`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "whl": { - "description": "URI of the wheel library to install. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs.\nFor example: `{ \"whl\": \"/Workspace/path/to/library.whl\" }`, `{ \"whl\" : \"/Volumes/path/to/library.whl\" }` or\n`{ \"whl\": \"s3://my-bucket/library.whl\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.LocalFileInfo": { - "type": "object", - "properties": { - "destination": { - "description": "local file destination, e.g. `file:/my/local/file.sh`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "destination" - ] - }, - "compute.LogAnalyticsInfo": { - "type": "object", - "properties": { - "log_analytics_primary_key": { - "description": "The primary key for the Azure Log Analytics agent configuration", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "log_analytics_workspace_id": { - "description": "The workspace ID for the Azure Log Analytics agent configuration", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "compute.MavenLibrary": { - "type": "object", - "properties": { - "coordinates": { - "description": "Gradle-style maven coordinates. For example: \"org.jsoup:jsoup:1.7.2\".", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "exclusions": { - "description": "List of dependences to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "repo": { - "description": "Maven repo to install the Maven package from. If omitted, both Maven Central Repository\nand Spark Packages are searched.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "coordinates" - ] - }, - "compute.NodeTypeFlexibility": { - "type": "object", - "description": "Configuration for flexible node types, allowing fallback to alternate node types during cluster launch and upscale.", - "properties": { - "alternate_node_type_ids": { - "description": "A list of node type IDs to use as fallbacks when the primary node type is unavailable.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.285.0" - } - }, - "additionalProperties": false - }, - "compute.PythonPyPiLibrary": { - "type": "object", - "properties": { - "package": { - "description": "The name of the pypi package to install. An optional exact version specification is also\nsupported. Examples: \"simplejson\" and \"simplejson==3.8.0\".", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "repo": { - "description": "The repository where the package can be found. If not specified, the default pip index is\nused.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "package" - ] - }, - "compute.RCranLibrary": { - "type": "object", - "properties": { - "package": { - "description": "The name of the CRAN package to install.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "repo": { - "description": "The repository where the package can be found. If not specified, the default CRAN repo is used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "package" - ] - }, - "compute.RuntimeEngine": { - "type": "string", - "enum": [ - "NULL", - "STANDARD", - "PHOTON" - ] - }, - "compute.S3StorageInfo": { - "type": "object", - "description": "A storage location in Amazon S3", - "properties": { - "canned_acl": { - "description": "(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\nthe destination bucket and prefix. The full list of possible canned acl can be found at\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\nPlease also note that by default only the object owner gets full controls. If you are using cross account\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\nread the logs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "destination": { - "description": "S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\ndestination. Please also note that you cannot use AWS keys to deliver logs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "enable_encryption": { - "description": "(Optional) Flag to enable server side encryption, `false` by default.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "encryption_type": { - "description": "(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\nencryption is enabled and the default type is `sse-s3`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "endpoint": { - "description": "S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\nIf both are set, endpoint will be used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "kms_key": { - "description": "(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "region": { - "description": "S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\nendpoint will be used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "destination" - ] - }, - "compute.VolumesStorageInfo": { - "type": "object", - "description": "A storage location back by UC Volumes.", - "properties": { - "destination": { - "description": "UC Volumes destination, e.g. `/Volumes/catalog/schema/vol1/init-scripts/setup-datadog.sh`\nor `dbfs:/Volumes/catalog/schema/vol1/init-scripts/setup-datadog.sh`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "destination" - ] - }, - "compute.WorkloadType": { - "type": "object", - "description": "Cluster Attributes showing for clusters workload types.", - "properties": { - "clients": { - "description": "defined what type of clients can use the cluster. E.g. Notebooks, Jobs", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClientsTypes", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "clients" - ] - }, - "compute.WorkspaceStorageInfo": { - "type": "object", - "description": "A storage location in Workspace Filesystem (WSFS)", - "properties": { - "destination": { - "description": "wsfs destination, e.g. `workspace:/cluster-init-scripts/setup-datadog.sh`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "destination" - ] - }, - "dashboards.LifecycleState": { - "type": "string", - "enum": [ - "ACTIVE", - "TRASHED" - ] - }, - "database.CustomTag": { - "type": "object", - "properties": { - "key": { - "description": "[Beta] The key of the custom tag.", - "$ref": "#/$defs/string", - "x-since-version": "v0.273.0" - }, - "value": { - "description": "[Beta] The value of the custom tag.", - "$ref": "#/$defs/string", - "x-since-version": "v0.273.0" - } - }, - "additionalProperties": false - }, - "database.DatabaseInstanceRef": { - "type": "object", - "description": "DatabaseInstanceRef is a reference to a database instance. It is used in the\nDatabaseInstance object to refer to the parent instance of an instance and\nto refer the child instances of an instance.\nTo specify as a parent instance during creation of an instance,\nthe lsn and branch_time fields are optional. If not specified, the child\ninstance will be created from the latest lsn of the parent.\nIf both lsn and branch_time are specified, the lsn will be used to create\nthe child instance.", - "properties": { - "branch_time": { - "description": "[Public Preview] Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", - "$ref": "#/$defs/string", - "x-since-version": "v0.265.0" - }, - "lsn": { - "description": "[Public Preview] User-specified WAL LSN of the ref database instance.\n\nInput: For specifying the WAL LSN to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", - "$ref": "#/$defs/string", - "x-since-version": "v0.265.0" - }, - "name": { - "description": "[Public Preview] Name of the ref database instance.", - "$ref": "#/$defs/string", - "x-since-version": "v0.265.0" - } - }, - "additionalProperties": false - }, - "database.DatabaseInstanceState": { - "type": "string", - "enum": [ - "STARTING", - "AVAILABLE", - "DELETING", - "STOPPED", - "UPDATING", - "FAILING_OVER" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "database.DeltaTableSyncInfo": { - "type": "object", - "additionalProperties": false - }, - "database.NewPipelineSpec": { - "type": "object", - "description": "Custom fields that user can set for pipeline while creating SyncedDatabaseTable.\nNote that other fields of pipeline are still inferred by table def internally", - "properties": { - "budget_policy_id": { - "description": "[Beta] Budget policy to set on the newly created pipeline.", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - }, - "storage_catalog": { - "description": "[Public Preview] This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", - "$ref": "#/$defs/string", - "x-since-version": "v0.266.0" - }, - "storage_schema": { - "description": "[Public Preview] This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", - "$ref": "#/$defs/string", - "x-since-version": "v0.266.0" - } - }, - "additionalProperties": false - }, - "database.ProvisioningInfoState": { - "type": "string", - "enum": [ - "PROVISIONING", - "ACTIVE", - "FAILED", - "DELETING", - "UPDATING", - "DEGRADED" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "database.ProvisioningPhase": { - "type": "string", - "enum": [ - "PROVISIONING_PHASE_MAIN", - "PROVISIONING_PHASE_INDEX_SCAN", - "PROVISIONING_PHASE_INDEX_SORT" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "database.SyncedTableContinuousUpdateStatus": { - "type": "object", - "description": "Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE\nor the SYNCED_UPDATING_PIPELINE_RESOURCES state.", - "additionalProperties": false - }, - "database.SyncedTableFailedStatus": { - "type": "object", - "description": "Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", - "additionalProperties": false - }, - "database.SyncedTablePipelineProgress": { - "type": "object", - "description": "Progress information of the Synced Table data synchronization pipeline.", - "additionalProperties": false - }, - "database.SyncedTablePosition": { - "type": "object", - "additionalProperties": false - }, - "database.SyncedTableProvisioningStatus": { - "type": "object", - "description": "Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", - "additionalProperties": false - }, - "database.SyncedTableSchedulingPolicy": { - "type": "string", - "enum": [ - "CONTINUOUS", - "TRIGGERED", - "SNAPSHOT" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "database.SyncedTableSpec": { - "type": "object", - "description": "Specification of a synced database table.", - "properties": { - "accelerated_sync": { - "description": "[Private Preview] When true, enables accelerated sync mode for the initial data load.\nThis significantly improves performance for large tables.\nRequires workspace-level enablement.", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - }, - "create_database_objects_if_missing": { - "description": "[Public Preview] If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.266.0" - }, - "existing_pipeline_id": { - "description": "[Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline\nreferenced. This avoids creating a new pipeline and allows sharing existing compute.\nIn this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline.", - "$ref": "#/$defs/string", - "x-since-version": "v0.266.0" - }, - "new_pipeline_spec": { - "description": "[Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used\nto store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta\ntables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table\nonly requires read permissions.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec", - "x-since-version": "v0.266.0" - }, - "primary_key_columns": { - "description": "[Public Preview] Primary Key columns to be used for data insert/update in the destination.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.266.0" - }, - "scheduling_policy": { - "description": "[Public Preview] Scheduling policy of the underlying pipeline.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPolicy", - "x-since-version": "v0.266.0" - }, - "source_table_full_name": { - "description": "[Public Preview] Three-part (catalog, schema, table) name of the source Delta table.", - "$ref": "#/$defs/string", - "x-since-version": "v0.266.0" - }, - "timeseries_key": { - "description": "[Public Preview] Time series key to deduplicate (tie-break) rows with the same primary key.", - "$ref": "#/$defs/string", - "x-since-version": "v0.266.0" - }, - "type_overrides": { - "description": "[Private Preview] Override the default Delta-\u003ePG type mapping for specific columns.\nA TypeOverride with PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid pg_type must be set.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpecTypeOverride", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - } - }, - "additionalProperties": false - }, - "database.SyncedTableSpecPgSpecificType": { - "type": "string", - "description": "PostgreSQL-specific target types that can override the default Delta-to-PG mapping.", - "enum": [ - "PG_SPECIFIC_TYPE_VECTOR" - ], - "enumDescriptions": [ - "[Private Preview]" - ] - }, - "database.SyncedTableSpecTypeOverride": { - "type": "object", - "description": "Overrides the default Delta-to-PostgreSQL type mapping for a single column.", - "properties": { - "column_name": { - "description": "[Private Preview] Name of the source column whose target PostgreSQL type should be overridden.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - }, - "pg_type": { - "description": "[Private Preview] PostgreSQL-specific target type to use for the column.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpecPgSpecificType", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - }, - "size": { - "description": "[Private Preview] Size parameter for the target type. Required when pg_type is PG_SPECIFIC_TYPE_VECTOR\n(specifies the vector dimension, e.g., 1024).", - "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - } - }, - "additionalProperties": false, - "required": [ - "column_name", - "pg_type" - ] - }, - "database.SyncedTableState": { - "type": "string", - "description": "The state of a synced table.", - "enum": [ - "SYNCED_TABLE_PROVISIONING", - "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES", - "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT", - "SYNCED_TABLE_ONLINE", - "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE", - "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE", - "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE", - "SYNCED_TABLED_OFFLINE", - "SYNCED_TABLE_OFFLINE_FAILED", - "SYNCED_TABLE_ONLINE_PIPELINE_FAILED", - "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "database.SyncedTableStatus": { - "type": "object", - "description": "Status of a synced table.", - "properties": { - "continuous_update_status": { - "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE\nor the SYNCED_UPDATING_PIPELINE_RESOURCES state.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus", - "x-since-version": "v0.266.0" - }, - "failed_status": { - "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus", - "x-since-version": "v0.266.0" - }, - "provisioning_status": { - "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioningStatus", - "x-since-version": "v0.266.0" - }, - "triggered_update_status": { - "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE\nor the SYNCED_NO_PENDING_UPDATE state.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpdateStatus", - "x-since-version": "v0.266.0" - } - }, - "additionalProperties": false - }, - "database.SyncedTableTriggeredUpdateStatus": { - "type": "object", - "description": "Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE\nor the SYNCED_NO_PENDING_UPDATE state.", - "additionalProperties": false - }, - "iam.PermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "CAN_RESTART", - "CAN_ATTACH_TO", - "IS_OWNER", - "CAN_MANAGE_RUN", - "CAN_VIEW", - "CAN_READ", - "CAN_RUN", - "CAN_EDIT", - "CAN_USE", - "CAN_MANAGE_STAGING_VERSIONS", - "CAN_MANAGE_PRODUCTION_VERSIONS", - "CAN_EDIT_METADATA", - "CAN_VIEW_METADATA", - "CAN_BIND", - "CAN_QUERY", - "CAN_MONITOR", - "CAN_CREATE", - "CAN_MONITOR_ONLY", - "CAN_CREATE_APP" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "[Private Preview]", - "[Private Preview]" - ] - }, - "jobs.AlertTask": { - "type": "object", - "properties": { - "alert_id": { - "description": "[Public Preview] The alert_id is the canonical identifier of the alert.", - "$ref": "#/$defs/string", - "x-since-version": "v0.296.0" - }, - "subscribers": { - "description": "[Public Preview] The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber", - "x-since-version": "v0.296.0" - }, - "warehouse_id": { - "description": "[Public Preview] The warehouse_id identifies the warehouse settings used by the alert task.", - "$ref": "#/$defs/string", - "x-since-version": "v0.296.0" - }, - "workspace_path": { - "description": "[Public Preview] The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", - "$ref": "#/$defs/string", - "x-since-version": "v0.296.0" - } - }, - "additionalProperties": false - }, - "jobs.AlertTaskSubscriber": { - "type": "object", - "description": "Represents a subscriber that will receive alert notifications.\nA subscriber can be either a user (via email) or a notification destination (via destination_id).", - "properties": { - "destination_id": { - "description": "[Public Preview]", - "$ref": "#/$defs/string", - "x-since-version": "v0.296.0" - }, - "user_name": { - "description": "[Public Preview] A valid workspace email address.", - "$ref": "#/$defs/string", - "x-since-version": "v0.296.0" - } - }, - "additionalProperties": false - }, - "jobs.AuthenticationMethod": { - "type": "string", - "enum": [ - "OAUTH", - "PAT" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]" - ] - }, - "jobs.CleanRoomsNotebookTask": { - "type": "object", - "description": "Clean Rooms notebook task for V1 Clean Room service (GA).\nReplaces the deprecated CleanRoomNotebookTask (defined above) which was for V0 service.", - "properties": { - "clean_room_name": { - "description": "The clean room that the notebook belongs to.", - "$ref": "#/$defs/string", - "x-since-version": "v0.237.0" - }, - "etag": { - "description": "Checksum to validate the freshness of the notebook resource (i.e. the notebook being run is the latest version).\nIt can be fetched by calling the :method:cleanroomassets/get API.", - "$ref": "#/$defs/string", - "x-since-version": "v0.237.0" - }, - "notebook_base_parameters": { - "description": "Base parameters to be used for the clean room notebook job.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.237.0" - }, - "notebook_name": { - "description": "Name of the notebook being run.", - "$ref": "#/$defs/string", - "x-since-version": "v0.237.0" - } - }, - "additionalProperties": false, - "required": [ - "clean_room_name", - "notebook_name" - ] - }, - "jobs.Compute": { - "type": "object", - "properties": { - "hardware_accelerator": { - "description": "[Beta] Hardware accelerator configuration for Serverless GPU workloads.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType", - "x-since-version": "v0.288.0" - } - }, - "additionalProperties": false - }, - "jobs.ComputeConfig": { - "type": "object", - "properties": { - "gpu_node_pool_id": { - "description": "[Private Preview] IDof the GPU pool to use.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - }, - "gpu_type": { - "description": "[Private Preview] GPU type.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - }, - "num_gpus": { - "description": "[Private Preview] Number of GPUs.", - "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - } - }, - "additionalProperties": false, - "required": [ - "num_gpus" - ] - }, - "jobs.Condition": { - "type": "string", - "enum": [ - "ANY_UPDATED", - "ALL_UPDATED" - ] - }, - "jobs.ConditionTask": { - "type": "object", - "properties": { - "left": { - "description": "The left operand of the condition task. Can be either a string value or a job state or parameter reference.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "op": { - "description": "* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `“12.0” == “12”` will evaluate to `false`.\n* `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `“12.0” \u003e= “12”` will evaluate to `true`, `“10.0” \u003e= “12”` will evaluate to `false`.\n\nThe boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `“true”` or `“false”` for the comparison.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ConditionTaskOp", - "x-since-version": "v0.229.0" - }, - "right": { - "description": "The right operand of the condition task. Can be either a string value or a job state or parameter reference.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "left", - "op", - "right" - ] - }, - "jobs.ConditionTaskOp": { - "type": "string", - "description": "* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `“12.0” == “12”` will evaluate to `false`.\n* `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `“12.0” \u003e= “12”` will evaluate to `true`, `“10.0” \u003e= “12”` will evaluate to `false`.\n\nThe boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `“true”` or `“false”` for the comparison.", - "enum": [ - "EQUAL_TO", - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL", - "LESS_THAN", - "LESS_THAN_OR_EQUAL", - "NOT_EQUAL" - ] - }, - "jobs.Continuous": { - "type": "object", - "properties": { - "pause_status": { - "description": "Indicate whether the continuous execution of the job is paused or not. Defaults to UNPAUSED.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", - "x-since-version": "v0.229.0" - }, - "task_retry_mode": { - "description": "Indicate whether the continuous job is applying task level retries or not. Defaults to NEVER.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskRetryMode", - "x-since-version": "v0.267.0" - } - }, - "additionalProperties": false - }, - "jobs.CronSchedule": { - "type": "object", - "properties": { - "pause_status": { - "description": "Indicate whether this schedule is paused or not.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", - "x-since-version": "v0.229.0" - }, - "quartz_cron_expression": { - "description": "A Cron expression using Quartz syntax that describes the schedule for a job. See [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details. This field is required.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "timezone_id": { - "description": "A Java timezone ID. The schedule for a job is resolved with respect to this timezone. See [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details. This field is required.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "quartz_cron_expression", - "timezone_id" - ] - }, - "jobs.DashboardTask": { - "type": "object", - "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" - }, - "filters": { - "description": "[Private Preview] Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key.\nThe parameter value format is dependent on the filter type:\n- For text and single-select filters, provide a single value (e.g. `\"value\"`)\n- For date and datetime filters, provide the value in ISO 8601 format (e.g. `\"2000-01-01T00:00:00\"`)\n- For multi-select filters, provide a JSON array of values (e.g. `\"[\\\"value1\\\",\\\"value2\\\"]\"`)\n- For range and date range filters, provide a JSON object with `start` and `end` (e.g. `\"{\\\"start\\\":\\\"1\\\",\\\"end\\\":\\\"10\\\"}\"`)", - "$ref": "#/$defs/map/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "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" - }, - "warehouse_id": { - "description": "Optional: The warehouse id to execute the dashboard with for the schedule.\nIf not specified, the default warehouse of the dashboard will be used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.248.0" - } - }, - "additionalProperties": false - }, - "jobs.DbtCloudTask": { - "type": "object", - "description": "Deprecated in favor of DbtPlatformTask", - "properties": { - "connection_resource_name": { - "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt Cloud for this task", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.256.0" - }, - "dbt_cloud_job_id": { - "description": "[Private Preview] Id of the dbt Cloud job to be triggered", - "$ref": "#/$defs/int64", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.256.0" - } - }, - "additionalProperties": false - }, - "jobs.DbtPlatformTask": { - "type": "object", - "properties": { - "connection_resource_name": { - "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.257.0" - }, - "dbt_platform_job_id": { - "description": "[Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.257.0" - } - }, - "additionalProperties": false - }, - "jobs.DbtTask": { - "type": "object", - "properties": { - "catalog": { - "description": "Optional name of the catalog to use. The value is the top level in the 3-level namespace of Unity Catalog (catalog / schema / relation). The catalog value can only be specified if a warehouse_id is specified. Requires dbt-databricks \u003e= 1.1.1.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "commands": { - "description": "A list of dbt commands to execute. All commands must start with `dbt`. This parameter must not be empty. A maximum of up to 10 commands can be provided.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "profiles_directory": { - "description": "Optional (relative) path to the profiles directory. Can only be specified if no warehouse_id is specified. If no warehouse_id is specified and this folder is unset, the root directory is used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "project_directory": { - "description": "Path to the project directory. Optional for Git sourced tasks, in which\ncase if no value is provided, the root of the Git repository is used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "schema": { - "description": "Optional schema to write to. This parameter is only used when a warehouse_id is also provided. If not provided, the `default` schema is used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "source": { - "description": "Optional location type of the project directory. When set to `WORKSPACE`, the project will be retrieved\nfrom the local Databricks workspace. When set to `GIT`, the project will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n\n* `WORKSPACE`: Project is located in Databricks workspace.\n* `GIT`: Project is located in cloud Git provider.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", - "x-since-version": "v0.229.0" - }, - "warehouse_id": { - "description": "ID of the SQL warehouse to connect to. If provided, we automatically generate and provide the profile and connection details to dbt. It can be overridden on a per-command basis by using the `--profiles-dir` command line argument.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "commands" - ] - }, - "jobs.FileArrivalTriggerConfiguration": { - "type": "object", - "properties": { - "min_time_between_triggers_seconds": { - "description": "If set, the trigger starts a run only after the specified amount of time passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "url": { - "description": "URL to be monitored for file arrivals. The path must point to the root or a subpath of the external location.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "wait_after_last_change_seconds": { - "description": "If set, the trigger starts a run only after no file activity has occurred for the specified amount of time.\nThis makes it possible to wait for a batch of incoming files to arrive before triggering a run. The\nminimum allowed value is 60 seconds.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "url" - ] - }, - "jobs.ForEachTask": { - "type": "object", - "properties": { - "concurrency": { - "description": "An optional maximum allowed number of concurrent runs of the task.\nSet this value if you want to be able to execute multiple runs of the task concurrently.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "inputs": { - "description": "Array for task to iterate on. This can be a JSON string or a reference to\nan array parameter.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "task": { - "description": "Configuration for the task that will be run for each element in the array", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Task", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "inputs", - "task" - ] - }, - "jobs.Format": { - "type": "string", - "enum": [ - "SINGLE_TASK", - "MULTI_TASK" - ] - }, - "jobs.GenAiComputeTask": { - "type": "object", - "description": "DEPRECATED — use `AiRuntimeTask` for all new BYOT multi-node GPU\nworkloads (see ai_runtime_task.proto). `AiRuntimeTask` is the only\nsupported BYOT task type for new workloads; this proto is retained only\nfor AIR CLI (fka SGCLI) pywheel backwards compatibility and will be\nremoved once the pywheel → databricks-cli migration completes (post-\nPuPr).", - "properties": { - "command": { - "description": "[Private Preview] Command launcher to run the actual script, e.g. bash, python etc.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - }, - "compute": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - }, - "dl_runtime_image": { - "description": "[Private Preview] Runtime image", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - }, - "mlflow_experiment_name": { - "description": "[Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - }, - "source": { - "description": "[Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - }, - "training_script_path": { - "description": "[Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - }, - "yaml_parameters": { - "description": "[Private Preview] Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - }, - "yaml_parameters_file_path": { - "description": "[Private Preview] Optional path to a YAML file containing model parameters passed to the training script.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.243.0" - } - }, - "additionalProperties": false, - "required": [ - "dl_runtime_image" - ] - }, - "jobs.GitProvider": { - "type": "string", - "enum": [ - "gitHub", - "bitbucketCloud", - "azureDevOpsServices", - "gitHubEnterprise", - "bitbucketServer", - "gitLab", - "gitLabEnterpriseEdition", - "awsCodeCommit" - ] - }, - "jobs.GitSnapshot": { - "type": "object", - "description": "Read-only state of the remote repository at the time the job was run. This field is only included on job runs.", - "properties": { - "used_commit": { - "description": "Commit that was used to execute the run. If git_branch was specified, this points to the HEAD of the branch at the time of the run; if git_tag was specified, this points to the commit the tag points to.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.GitSource": { - "type": "object", - "description": "An optional specification for a remote Git repository containing the source code used by tasks. Version-controlled source code is supported by notebook, dbt, Python script, and SQL File tasks.\n\nIf `git_source` is set, these tasks retrieve the file from the remote repository by default. However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.\n\nNote: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks are used, `git_source` must be defined on the job.", - "properties": { - "git_branch": { - "description": "Name of the branch to be checked out and used by this job. This field cannot be specified in conjunction with git_tag or git_commit.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "git_commit": { - "description": "Commit to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_tag.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "git_provider": { - "description": "Unique identifier of the service used to host the Git repository. The value is case insensitive.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GitProvider", - "x-since-version": "v0.229.0" - }, - "git_tag": { - "description": "Name of the tag to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_commit.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "git_url": { - "description": "URL of the repository to be cloned by this job.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "sparse_checkout": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparseCheckout", - "x-since-version": "v0.290.0" - } - }, - "additionalProperties": false, - "required": [ - "git_provider", - "git_url" - ] - }, - "jobs.JobCluster": { - "type": "object", - "properties": { - "job_cluster_key": { - "description": "A unique name for the job cluster. This field is required and must be unique within the job.\n`JobTaskSettings` may refer to this field to determine which cluster to launch for the task execution.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "new_cluster": { - "description": "If new_cluster, a description of a cluster that is created for each task.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "job_cluster_key", - "new_cluster" - ] - }, - "jobs.JobDeployment": { - "type": "object", - "properties": { - "kind": { - "description": "The kind of deployment that manages the job.\n\n* `BUNDLE`: The job is managed by Databricks Asset Bundle.\n* `SYSTEM_MANAGED`: The job is managed by Databricks and is read-only.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobDeploymentKind", - "x-since-version": "v0.229.0" - }, - "metadata_file_path": { - "description": "Path of the file that contains deployment metadata.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "kind" - ] - }, - "jobs.JobDeploymentKind": { - "type": "string", - "description": "* `BUNDLE`: The job is managed by Databricks Asset Bundle.\n* `SYSTEM_MANAGED`: The job is managed by Databricks and is read-only.", - "enum": [ - "BUNDLE", - "SYSTEM_MANAGED" - ], - "enumDescriptions": [ - "The job is managed by Databricks Asset Bundle.", - "[Beta] The job is managed by \u003cDatabricks\u003e and is read-only." - ] - }, - "jobs.JobEditMode": { - "type": "string", - "description": "Edit mode of the job.\n\n* `UI_LOCKED`: The job is in a locked UI state and cannot be modified.\n* `EDITABLE`: The job is in an editable state and can be modified.", - "enum": [ - "UI_LOCKED", - "EDITABLE" - ], - "enumDescriptions": [ - "The job is in a locked UI state and cannot be modified.", - "The job is in an editable state and can be modified." - ] - }, - "jobs.JobEmailNotifications": { - "type": "object", - "properties": { - "no_alert_for_skipped_runs": { - "description": "If true, do not send email to recipients specified in `on_failure` if the run is skipped.\nThis field is `deprecated`. Please use the `notification_settings.no_alert_for_skipped_runs` field.", - "$ref": "#/$defs/bool", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "on_duration_warning_threshold_exceeded": { - "description": "A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. If no rule for the `RUN_DURATION_SECONDS` metric is specified in the `health` field for the job, notifications are not sent.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "on_failure": { - "description": "A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "on_start": { - "description": "A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "on_streaming_backlog_exceeded": { - "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "on_success": { - "description": "A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.JobEnvironment": { - "type": "object", - "properties": { - "environment_key": { - "description": "The key of an environment. It has to be unique within a job.", - "$ref": "#/$defs/string", - "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" - } - }, - "additionalProperties": false, - "required": [ - "environment_key" - ] - }, - "jobs.JobNotificationSettings": { - "type": "object", - "properties": { - "no_alert_for_canceled_runs": { - "description": "If true, do not send notifications to recipients specified in `on_failure` if the run is canceled.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "no_alert_for_skipped_runs": { - "description": "If true, do not send notifications to recipients specified in `on_failure` if the run is skipped.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.JobParameterDefinition": { - "type": "object", - "properties": { - "default": { - "description": "Default value of the parameter.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "name": { - "description": "The name of the defined parameter. May only contain alphanumeric characters, `_`, `-`, and `.`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "default", - "name" - ] - }, - "jobs.JobPermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "IS_OWNER", - "CAN_MANAGE_RUN", - "CAN_VIEW" - ] - }, - "jobs.JobRunAs": { - "type": "object", - "description": "Write-only setting. Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who created the job.\n\nEither `user_name` or `service_principal_name` should be specified. If not, an error is thrown.", - "properties": { - "group_name": { - "description": "[Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.283.0" - }, - "service_principal_name": { - "description": "The application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "user_name": { - "description": "The email of an active workspace user. Non-admin users can only set this field to their own email.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.JobSource": { - "type": "object", - "description": "The source of the job specification in the remote repository when the job is source controlled.", - "properties": { - "dirty_state": { - "description": "[Private Preview] Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - }, - "import_from_git_branch": { - "description": "[Private Preview] Name of the branch which the job is imported from.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - }, - "job_config_path": { - "description": "[Private Preview] Path of the job YAML file that contains the job specification.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "import_from_git_branch", - "job_config_path" - ] - }, - "jobs.JobSourceDirtyState": { - "type": "string", - "description": "Dirty state indicates the job is not fully synced with the job specification\nin the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", - "enum": [ - "NOT_SYNCED", - "DISCONNECTED" - ], - "enumDescriptions": [ - "[Private Preview] The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.", - "[Private Preview] The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced." - ] - }, - "jobs.JobsHealthMetric": { - "type": "string", - "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.", - "enum": [ - "RUN_DURATION_SECONDS", - "STREAMING_BACKLOG_BYTES", - "STREAMING_BACKLOG_RECORDS", - "STREAMING_BACKLOG_SECONDS", - "STREAMING_BACKLOG_FILES" - ], - "enumDescriptions": [ - "Expected total time for a run in seconds.", - "An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.", - "An estimate of the maximum offset lag across all streams. This metric is in Public Preview.", - "An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.", - "An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview." - ] - }, - "jobs.JobsHealthOperator": { - "type": "string", - "description": "Specifies the operator used to compare the health metric value with the specified threshold.", - "enum": [ - "GREATER_THAN" - ] - }, - "jobs.JobsHealthRule": { - "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" - }, - "value": { - "description": "Specifies the threshold value that the health metric should obey to satisfy the health rule.", - "$ref": "#/$defs/int64", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "metric", - "op", - "value" - ] - }, - "jobs.JobsHealthRules": { - "type": "object", - "description": "An optional set of health rules that can be defined for this job.", - "properties": { - "rules": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRule", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.ModelTriggerConfiguration": { - "type": "object", - "properties": { - "aliases": { - "description": "[Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.279.0" - }, - "condition": { - "description": "[Private Preview] The condition based on which to trigger a job run.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.279.0" - }, - "min_time_between_triggers_seconds": { - "description": "[Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", - "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.279.0" - }, - "securable_name": { - "description": "[Private Preview] Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.279.0" - }, - "wait_after_last_change_seconds": { - "description": "[Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", - "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false, - "required": [ - "condition" - ] - }, - "jobs.ModelTriggerConfigurationCondition": { - "type": "string", - "enum": [ - "MODEL_CREATED", - "MODEL_VERSION_READY", - "MODEL_ALIAS_SET" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" - ] - }, - "jobs.NotebookTask": { - "type": "object", - "properties": { - "base_parameters": { - "description": "Base parameters to be used for each run of this job. If the run is initiated by a call to :method:jobs/run\nNow with parameters specified, the two parameters maps are merged. If the same key is specified in\n`base_parameters` and in `run-now`, the value from `run-now` is used.\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nIf the notebook takes a parameter that is not specified in the job’s `base_parameters` or the `run-now` override parameters,\nthe default value from the notebook is used.\n\nRetrieve these parameters in a notebook using [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-widgets).\n\nThe JSON representation of this field cannot exceed 1MB.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "notebook_path": { - "description": "The path of the notebook to be run in the Databricks workspace or remote repository.\nFor notebooks stored in the Databricks workspace, the path must be absolute and begin with a slash.\nFor notebooks stored in a remote repository, the path must be relative. This field is required.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "source": { - "description": "Optional location type of the notebook. When set to `WORKSPACE`, the notebook will be retrieved from the local Databricks workspace. When set to `GIT`, the notebook will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Notebook is located in Databricks workspace.\n* `GIT`: Notebook is located in cloud Git provider.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", - "x-since-version": "v0.229.0" - }, - "warehouse_id": { - "description": "Optional `warehouse_id` to run the notebook on a SQL warehouse. Classic SQL warehouses are NOT supported, please use serverless or pro SQL warehouses.\n\nNote that SQL warehouses only support SQL cells; if the notebook contains non-SQL cells, the run will fail.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "notebook_path" - ] - }, - "jobs.PauseStatus": { - "type": "string", - "enum": [ - "UNPAUSED", - "PAUSED" - ] - }, - "jobs.PerformanceTarget": { - "type": "string", - "description": "PerformanceTarget defines how performant (lower latency) or cost efficient the execution of run on serverless compute should be.\nThe performance mode on the job or pipeline should map to a performance setting that is passed to Cluster Manager\n(see cluster-common PerformanceTarget).", - "enum": [ - "PERFORMANCE_OPTIMIZED", - "STANDARD" - ] - }, - "jobs.PeriodicTriggerConfiguration": { - "type": "object", - "properties": { - "interval": { - "description": "The interval at which the trigger should run.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "unit": { - "description": "The unit of time for the interval.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfigurationTimeUnit", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "interval", - "unit" - ] - }, - "jobs.PeriodicTriggerConfigurationTimeUnit": { - "type": "string", - "enum": [ - "HOURS", - "DAYS", - "WEEKS" - ] - }, - "jobs.PipelineParams": { - "type": "object", - "properties": { - "full_refresh": { - "description": "If true, triggers a full refresh on the spark declarative pipeline.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "full_refresh_selection": { - "description": "[Beta] A list of tables to update with fullRefresh.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v1.1.0" - }, - "refresh_flow_selection": { - "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v1.1.0" - }, - "refresh_selection": { - "description": "[Beta] A list of tables to update without fullRefresh.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v1.1.0" - }, - "reset_checkpoint_selection": { - "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v1.1.0" - } - }, - "additionalProperties": false - }, - "jobs.PipelineTask": { - "type": "object", - "properties": { - "full_refresh": { - "description": "If true, triggers a full refresh on the spark declarative pipeline.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "full_refresh_selection": { - "description": "[Beta] A list of tables to update with fullRefresh.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v1.1.0" - }, - "parameters": { - "description": "[Beta] Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", - "$ref": "#/$defs/map/string", - "x-since-version": "v1.2.0" - }, - "pipeline_id": { - "description": "The full name of the pipeline task to execute.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "refresh_flow_selection": { - "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v1.1.0" - }, - "refresh_selection": { - "description": "[Beta] A list of tables to update without fullRefresh.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v1.1.0" - }, - "reset_checkpoint_selection": { - "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v1.1.0" - } - }, - "additionalProperties": false, - "required": [ - "pipeline_id" - ] - }, - "jobs.PowerBiModel": { - "type": "object", - "properties": { - "authentication_method": { - "description": "[Public Preview] How the published Power BI model authenticates to Databricks", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod", - "x-since-version": "v0.248.0" - }, - "model_name": { - "description": "[Public Preview] The name of the Power BI model", - "$ref": "#/$defs/string", - "x-since-version": "v0.248.0" - }, - "overwrite_existing": { - "description": "[Public Preview] Whether to overwrite existing Power BI models", - "$ref": "#/$defs/bool", - "x-since-version": "v0.248.0" - }, - "storage_mode": { - "description": "[Public Preview] The default storage mode of the Power BI model", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode", - "x-since-version": "v0.248.0" - }, - "workspace_name": { - "description": "[Public Preview] The name of the Power BI workspace of the model", - "$ref": "#/$defs/string", - "x-since-version": "v0.248.0" - } - }, - "additionalProperties": false - }, - "jobs.PowerBiTable": { - "type": "object", - "properties": { - "catalog": { - "description": "[Public Preview] The catalog name in Databricks", - "$ref": "#/$defs/string", - "x-since-version": "v0.248.0" - }, - "name": { - "description": "[Public Preview] The table name in Databricks", - "$ref": "#/$defs/string", - "x-since-version": "v0.248.0" - }, - "schema": { - "description": "[Public Preview] The schema name in Databricks", - "$ref": "#/$defs/string", - "x-since-version": "v0.248.0" - }, - "storage_mode": { - "description": "[Public Preview] The Power BI storage mode of the table", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode", - "x-since-version": "v0.248.0" - } - }, - "additionalProperties": false - }, - "jobs.PowerBiTask": { - "type": "object", - "properties": { - "connection_resource_name": { - "description": "[Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI", - "$ref": "#/$defs/string", - "x-since-version": "v0.248.0" - }, - "power_bi_model": { - "description": "[Public Preview] The semantic model to update", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiModel", - "x-since-version": "v0.248.0" - }, - "refresh_after_update": { - "description": "[Public Preview] Whether the model should be refreshed after the update", - "$ref": "#/$defs/bool", - "x-since-version": "v0.248.0" - }, - "tables": { - "description": "[Public Preview] The tables to be exported to Power BI", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable", - "x-since-version": "v0.248.0" - }, - "warehouse_id": { - "description": "[Public Preview] The SQL warehouse ID to use as the Power BI data source", - "$ref": "#/$defs/string", - "x-since-version": "v0.248.0" - } - }, - "additionalProperties": false - }, - "jobs.PythonOperatorTask": { - "type": "object", - "properties": { - "main": { - "description": "[Private Preview] Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "parameters": { - "description": "[Private Preview] An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - } - }, - "additionalProperties": false - }, - "jobs.PythonOperatorTaskParameter": { - "type": "object", - "properties": { - "name": { - "description": "[Private Preview]", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "value": { - "description": "[Private Preview]", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - } - }, - "additionalProperties": false - }, - "jobs.PythonWheelTask": { - "type": "object", - "properties": { - "entry_point": { - "description": "Named entry point to use, if it does not exist in the metadata of the package it executes the function from the package directly using `$packageName.$entryPoint()`", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "named_parameters": { - "description": "Command-line parameters passed to Python wheel task in the form of `[\"--name=task\", \"--data=dbfs:/path/to/data.json\"]`. Leave it empty if `parameters` is not null.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "package_name": { - "description": "Name of the package to execute", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "parameters": { - "description": "Command-line parameters passed to Python wheel task. Leave it empty if `named_parameters` is not null.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "entry_point", - "package_name" - ] - }, - "jobs.QueueSettings": { - "type": "object", - "properties": { - "enabled": { - "description": "If true, enable queueing for the job. This is a required field.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "enabled" - ] - }, - "jobs.RunIf": { - "type": "string", - "description": "An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed. When omitted, defaults to `ALL_SUCCESS`.\n\nPossible values are:\n* `ALL_SUCCESS`: All dependencies have executed and succeeded\n* `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded\n* `NONE_FAILED`: None of the dependencies have failed and at least one was executed\n* `ALL_DONE`: All dependencies have been completed\n* `AT_LEAST_ONE_FAILED`: At least one dependency failed\n* `ALL_FAILED`: ALl dependencies have failed", - "enum": [ - "ALL_SUCCESS", - "ALL_DONE", - "NONE_FAILED", - "AT_LEAST_ONE_SUCCESS", - "ALL_FAILED", - "AT_LEAST_ONE_FAILED" - ], - "enumDescriptions": [ - "All dependencies have executed and succeeded", - "All dependencies have been completed", - "None of the dependencies have failed and at least one was executed", - "At least one dependency has succeeded", - "ALl dependencies have failed", - "At least one dependency failed" - ] - }, - "jobs.RunJobTask": { - "type": "object", - "properties": { - "dbt_commands": { - "description": "[Private Preview] An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.229.0", - "deprecated": true - }, - "jar_params": { - "description": "[Private Preview] A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.229.0", - "deprecated": true - }, - "job_id": { - "description": "ID of the job to trigger.", - "$ref": "#/$defs/int64", - "x-since-version": "v0.229.0" - }, - "job_parameters": { - "description": "Job-level parameters used to trigger the job.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "notebook_params": { - "description": "[Private Preview] A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.", - "$ref": "#/$defs/map/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.229.0", - "deprecated": true - }, - "pipeline_params": { - "description": "Controls whether the pipeline should perform a full refresh", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams", - "x-since-version": "v0.229.0" - }, - "python_named_params": { - "description": "[Private Preview]", - "$ref": "#/$defs/map/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.229.0", - "deprecated": true - }, - "python_params": { - "description": "[Private Preview] A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.229.0", - "deprecated": true - }, - "spark_submit_params": { - "description": "[Private Preview] A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.229.0", - "deprecated": true - }, - "sql_params": { - "description": "[Private Preview] A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", - "$ref": "#/$defs/map/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.229.0", - "deprecated": true - } - }, - "additionalProperties": false, - "required": [ - "job_id" - ] - }, - "jobs.Source": { - "type": "string", - "description": "Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved\\\nfrom the local Databricks workspace. When set to `GIT`, the SQL file will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n\n* `WORKSPACE`: SQL file is located in Databricks workspace.\n* `GIT`: SQL file is located in cloud Git provider.", - "enum": [ - "WORKSPACE", - "GIT" - ], - "enumDescriptions": [ - "SQL file is located in \u003cDatabricks\u003e workspace.", - "SQL file is located in cloud Git provider." - ] - }, - "jobs.SparkJarTask": { - "type": "object", - "properties": { - "jar_uri": { - "description": "Deprecated since 04/2016. For classic compute, provide a `jar` through the `libraries` field instead. For serverless compute, provide a `jar` though the `java_dependencies` field inside the `environments` list.\n\nSee the examples of classic and serverless compute usage at the top of the page.", - "$ref": "#/$defs/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "main_class_name": { - "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library.\n\nThe code must use `SparkContext.getOrCreate` to obtain a Spark context; otherwise, runs of the job fail.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "parameters": { - "description": "Parameters passed to the main method.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "run_as_repl": { - "description": "Deprecated. A value of `false` is no longer supported.", - "$ref": "#/$defs/bool", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.240.0", - "deprecated": true - } - }, - "additionalProperties": false - }, - "jobs.SparkPythonTask": { - "type": "object", - "properties": { - "parameters": { - "description": "Command line parameters passed to the Python file.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "python_file": { - "description": "The Python file to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "source": { - "description": "Optional location type of the Python file. When set to `WORKSPACE` or not specified, the file will be retrieved from the local\nDatabricks workspace or cloud location (if the `python_file` has a URI format). When set to `GIT`,\nthe Python file will be retrieved from a Git repository defined in `git_source`.\n\n* `WORKSPACE`: The Python file is located in a Databricks workspace or at a cloud filesystem URI.\n* `GIT`: The Python file is located in a remote Git repository.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "python_file" - ] - }, - "jobs.SparkSubmitTask": { - "type": "object", - "properties": { - "parameters": { - "description": "Command-line parameters passed to spark submit.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.SparseCheckout": { - "type": "object", - "properties": { - "patterns": { - "description": "List of patterns to include for sparse checkout.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.290.0" - } - }, - "additionalProperties": false - }, - "jobs.SqlTask": { - "type": "object", - "properties": { - "alert": { - "description": "If alert, indicates that this job must refresh a SQL alert.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskAlert", - "x-since-version": "v0.229.0" - }, - "dashboard": { - "description": "If dashboard, indicates that this job must refresh a SQL dashboard.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskDashboard", - "x-since-version": "v0.229.0" - }, - "file": { - "description": "If file, indicates that this job runs a SQL file in a remote Git repository.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskFile", - "x-since-version": "v0.229.0" - }, - "parameters": { - "description": "Parameters to be used for each run of this job. The SQL alert task does not support custom parameters.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "query": { - "description": "If query, indicates that this job must execute a SQL query.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskQuery", - "x-since-version": "v0.229.0" - }, - "warehouse_id": { - "description": "The canonical identifier of the SQL warehouse. Recommended to use with serverless or pro SQL warehouses. Classic SQL warehouses are only supported for SQL alert, dashboard and query tasks and are limited to scheduled single-task jobs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "warehouse_id" - ] - }, - "jobs.SqlTaskAlert": { - "type": "object", - "properties": { - "alert_id": { - "description": "The canonical identifier of the SQL alert.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "pause_subscriptions": { - "description": "If true, the alert notifications are not sent to subscribers.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "subscriptions": { - "description": "If specified, alert notifications are sent to subscribers.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "alert_id" - ] - }, - "jobs.SqlTaskDashboard": { - "type": "object", - "properties": { - "custom_subject": { - "description": "Subject of the email sent to subscribers of this task.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "dashboard_id": { - "description": "The canonical identifier of the SQL dashboard.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "pause_subscriptions": { - "description": "If true, the dashboard snapshot is not taken, and emails are not sent to subscribers.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "subscriptions": { - "description": "If specified, dashboard snapshots are sent to subscriptions.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "dashboard_id" - ] - }, - "jobs.SqlTaskFile": { - "type": "object", - "properties": { - "path": { - "description": "Path of the SQL file. Must be relative if the source is a remote Git repository and absolute for workspace paths.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "source": { - "description": "Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved\nfrom the local Databricks workspace. When set to `GIT`, the SQL file will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n\n* `WORKSPACE`: SQL file is located in Databricks workspace.\n* `GIT`: SQL file is located in cloud Git provider.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "path" - ] - }, - "jobs.SqlTaskQuery": { - "type": "object", - "properties": { - "query_id": { - "description": "The canonical identifier of the SQL query.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "query_id" - ] - }, - "jobs.SqlTaskSubscription": { - "type": "object", - "properties": { - "destination_id": { - "description": "The canonical identifier of the destination to receive email notification. This parameter is mutually exclusive with user_name. You cannot set both destination_id and user_name for subscription notifications.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "user_name": { - "description": "The user name to receive the subscription email. This parameter is mutually exclusive with destination_id. You cannot set both destination_id and user_name for subscription notifications.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.StorageMode": { - "type": "string", - "enum": [ - "DIRECT_QUERY", - "IMPORT", - "DUAL" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "jobs.Subscription": { - "type": "object", - "properties": { - "custom_subject": { - "description": "Optional: Allows users to specify a custom subject line on the email sent\nto subscribers.", - "$ref": "#/$defs/string", - "x-since-version": "v0.248.0" - }, - "paused": { - "description": "When true, the subscription will not send emails.", - "$ref": "#/$defs/bool", - "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" - } - }, - "additionalProperties": false - }, - "jobs.SubscriptionSubscriber": { - "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" - } - }, - "additionalProperties": false - }, - "jobs.TableUpdateTriggerConfiguration": { - "type": "object", - "properties": { - "condition": { - "description": "The table(s) condition based on which to trigger a job run.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Condition", - "x-since-version": "v0.229.0" - }, - "min_time_between_triggers_seconds": { - "description": "If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "table_names": { - "description": "A list of tables to monitor for changes. The table name must be in the format `catalog_name.schema_name.table_name`.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "wait_after_last_change_seconds": { - "description": "If set, the trigger starts a run only after no table updates have occurred for the specified time\nand can be used to wait for a series of table updates before triggering a run. The\nminimum allowed value is 60 seconds.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "table_names" - ] - }, - "jobs.Task": { - "type": "object", - "properties": { - "alert_task": { - "description": "[Public Preview] The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask", - "x-since-version": "v0.296.0" - }, - "clean_rooms_notebook_task": { - "description": "The task runs a [clean rooms](https://docs.databricks.com/clean-rooms/index.html) notebook\nwhen the `clean_rooms_notebook_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CleanRoomsNotebookTask", - "x-since-version": "v0.237.0" - }, - "compute": { - "description": "[Beta] Task level compute configuration.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", - "x-since-version": "v0.288.0" - }, - "condition_task": { - "description": "The task evaluates a condition that can be used to control the execution of other tasks when the `condition_task` field is present.\nThe condition task does not require a cluster to execute and does not support retries or notifications.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ConditionTask", - "x-since-version": "v0.229.0" - }, - "dashboard_task": { - "description": "The task refreshes a dashboard and sends a snapshot to subscribers.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DashboardTask", - "x-since-version": "v0.248.0" - }, - "dbt_cloud_task": { - "description": "[Private Preview] Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtCloudTask", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.256.0", - "deprecated": true - }, - "dbt_platform_task": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.257.0" - }, - "dbt_task": { - "description": "The task runs one or more dbt commands when the `dbt_task` field is present. The dbt task requires both Databricks SQL and the ability to use a serverless or a pro SQL warehouse.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtTask", - "x-since-version": "v0.229.0" - }, - "depends_on": { - "description": "An optional array of objects specifying the dependency graph of the task. All tasks specified in this field must complete before executing this task. The task will run only if the `run_if` condition is true.\nThe key is `task_key`, and the value is the name assigned to the dependent task.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.TaskDependency", - "x-since-version": "v0.229.0" - }, - "description": { - "description": "An optional description for this task.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "disable_auto_optimization": { - "description": "An option to disable auto optimization in serverless", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "disabled": { - "description": "An optional flag to disable the task. If set to true, the task will not run even if it is part of a job.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.271.0" - }, - "email_notifications": { - "description": "An optional set of email addresses that is notified when runs of this task begin or complete as well as when this task is deleted. The default behavior is to not send any emails.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskEmailNotifications", - "x-since-version": "v0.229.0" - }, - "environment_key": { - "description": "The key that references an environment spec in a job. This field is required for Python script, Python wheel and dbt tasks when using serverless compute.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "existing_cluster_id": { - "description": "If existing_cluster_id, the ID of an existing cluster that is used for all runs.\nWhen running jobs or tasks on an existing cluster, you may need to manually restart\nthe cluster if it stops responding. We suggest running jobs and tasks on new clusters for\ngreater reliability", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "for_each_task": { - "description": "The task executes a nested task for every input provided when the `for_each_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ForEachTask", - "x-since-version": "v0.229.0" - }, - "gen_ai_compute_task": { - "description": "[Private Preview] DEPRECATED — use `AiRuntimeTask` for all new BYOT multi-node GPU\nworkloads (see ai_runtime_task.proto). `AiRuntimeTask` is the only\nsupported BYOT task type for new workloads; this proto is retained only\nfor AIR CLI (fka SGCLI) pywheel backwards compatibility and will be\nremoved once the pywheel → databricks-cli migration completes (post-\nPuPr).", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "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" - }, - "job_cluster_key": { - "description": "If job_cluster_key, this task is executed reusing the cluster specified in `job.settings.job_clusters`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "libraries": { - "description": "An optional list of libraries to be installed on the cluster.\nThe default value is an empty list.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.Library", - "x-since-version": "v0.229.0" - }, - "max_retries": { - "description": "An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with the `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The value `-1` means to retry indefinitely and the value `0` means to never retry.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "min_retry_interval_millis": { - "description": "An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "new_cluster": { - "description": "If new_cluster, a description of a new cluster that is created for each run.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec", - "x-since-version": "v0.229.0" - }, - "notebook_task": { - "description": "The task runs a notebook when the `notebook_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.NotebookTask", - "x-since-version": "v0.229.0" - }, - "notification_settings": { - "description": "Optional notification settings that are used when sending notifications to each of the `email_notifications` and `webhook_notifications` for this task.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskNotificationSettings", - "x-since-version": "v0.229.0" - }, - "pipeline_task": { - "description": "The task triggers a pipeline update when the `pipeline_task` field is present. Only pipelines configured to use triggered more are supported.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask", - "x-since-version": "v0.229.0" - }, - "power_bi_task": { - "description": "[Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask", - "x-since-version": "v0.248.0" - }, - "python_operator_task": { - "description": "[Private Preview] The task runs a Python operator task.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "python_wheel_task": { - "description": "The task runs a Python wheel when the `python_wheel_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonWheelTask", - "x-since-version": "v0.229.0" - }, - "retry_on_timeout": { - "description": "An optional policy to specify whether to retry a job when it times out. The default behavior\nis to not retry on timeout.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "run_if": { - "description": "An optional value specifying the condition determining whether the task is run once its dependencies have been completed.\n\n* `ALL_SUCCESS`: All dependencies have executed and succeeded\n* `AT_LEAST_ONE_SUCCESS`: At least one dependency has succeeded\n* `NONE_FAILED`: None of the dependencies have failed and at least one was executed\n* `ALL_DONE`: All dependencies have been completed\n* `AT_LEAST_ONE_FAILED`: At least one dependency failed\n* `ALL_FAILED`: ALl dependencies have failed", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.RunIf", - "x-since-version": "v0.229.0" - }, - "run_job_task": { - "description": "The task triggers another job when the `run_job_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask", - "x-since-version": "v0.229.0" - }, - "spark_jar_task": { - "description": "The task runs a JAR when the `spark_jar_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkJarTask", - "x-since-version": "v0.229.0" - }, - "spark_python_task": { - "description": "The task runs a Python file when the `spark_python_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkPythonTask", - "x-since-version": "v0.229.0" - }, - "spark_submit_task": { - "description": "(Legacy) The task runs the spark-submit script when the spark_submit_task field is present. Databricks recommends using the spark_jar_task instead; see [Spark Submit task for jobs](/jobs/spark-submit).", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkSubmitTask", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "sql_task": { - "description": "The task runs a SQL query or file, or it refreshes a SQL alert or a legacy SQL dashboard when the `sql_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTask", - "x-since-version": "v0.229.0" - }, - "task_key": { - "description": "A unique name for the task. This field is used to refer to this task from other tasks.\nThis field is required and must be unique within its parent job.\nOn Update or Reset, this field is used to reference the tasks to be updated or reset.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "timeout_seconds": { - "description": "An optional timeout applied to each run of this job task. A value of `0` means no timeout.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "webhook_notifications": { - "description": "A collection of system notification IDs to notify when runs of this task begin or complete. The default behavior is to not send any system notifications.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "task_key" - ] - }, - "jobs.TaskDependency": { - "type": "object", - "properties": { - "outcome": { - "description": "Can only be specified on condition task dependencies. The outcome of the dependent task that must be met for this task to run.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "task_key": { - "description": "The name of the task this task depends on.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "task_key" - ] - }, - "jobs.TaskEmailNotifications": { - "type": "object", - "properties": { - "no_alert_for_skipped_runs": { - "description": "If true, do not send email to recipients specified in `on_failure` if the run is skipped.\nThis field is `deprecated`. Please use the `notification_settings.no_alert_for_skipped_runs` field.", - "$ref": "#/$defs/bool", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "on_duration_warning_threshold_exceeded": { - "description": "A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. If no rule for the `RUN_DURATION_SECONDS` metric is specified in the `health` field for the job, notifications are not sent.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "on_failure": { - "description": "A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "on_start": { - "description": "A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "on_streaming_backlog_exceeded": { - "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "on_success": { - "description": "A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.TaskNotificationSettings": { - "type": "object", - "properties": { - "alert_on_last_attempt": { - "description": "If true, do not send notifications to recipients specified in `on_start` for the retried runs and do not send notifications to recipients specified in `on_failure` until the last retry of the run.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "no_alert_for_canceled_runs": { - "description": "If true, do not send notifications to recipients specified in `on_failure` if the run is canceled.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "no_alert_for_skipped_runs": { - "description": "If true, do not send notifications to recipients specified in `on_failure` if the run is skipped.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.TaskRetryMode": { - "type": "string", - "description": "task retry mode of the continuous job\n* NEVER: The failed task will not be retried.\n* ON_FAILURE: Retry a failed task if at least one other task in the job is still running its first attempt.\nWhen this condition is no longer met or the retry limit is reached, the job run is cancelled and a new run is started.", - "enum": [ - "NEVER", - "ON_FAILURE" - ] - }, - "jobs.TriggerSettings": { - "type": "object", - "properties": { - "file_arrival": { - "description": "File arrival trigger settings.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration", - "x-since-version": "v0.229.0" - }, - "model": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.279.0" - }, - "pause_status": { - "description": "Whether this trigger is paused or not.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", - "x-since-version": "v0.229.0" - }, - "periodic": { - "description": "Periodic trigger settings.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration", - "x-since-version": "v0.229.0" - }, - "table_update": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "jobs.Webhook": { - "type": "object", - "properties": { - "id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "id" - ] - }, - "jobs.WebhookNotifications": { - "type": "object", - "properties": { - "on_duration_warning_threshold_exceeded": { - "description": "An optional list of system notification IDs to call when the duration of a run exceeds the threshold specified for the `RUN_DURATION_SECONDS` metric in the `health` field. A maximum of 3 destinations can be specified for the `on_duration_warning_threshold_exceeded` property.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", - "x-since-version": "v0.229.0" - }, - "on_failure": { - "description": "An optional list of system notification IDs to call when the run fails. A maximum of 3 destinations can be specified for the `on_failure` property.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", - "x-since-version": "v0.229.0" - }, - "on_start": { - "description": "An optional list of system notification IDs to call when the run starts. A maximum of 3 destinations can be specified for the `on_start` property.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", - "x-since-version": "v0.229.0" - }, - "on_streaming_backlog_exceeded": { - "description": "[Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", - "x-since-version": "v0.229.0" - }, - "on_success": { - "description": "An optional list of system notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified for the `on_success` property.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "ml.ExperimentPermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "CAN_EDIT", - "CAN_READ" - ] - }, - "ml.ExperimentTag": { - "type": "object", - "description": "A tag for an experiment.", - "properties": { - "key": { - "description": "The tag key.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "value": { - "description": "The tag value.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "ml.ModelTag": { - "type": "object", - "description": "Tag for a registered model", - "properties": { - "key": { - "description": "The tag key.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "value": { - "description": "The tag value.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "ml.RegisteredModelPermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "CAN_MANAGE_PRODUCTION_VERSIONS", - "CAN_MANAGE_STAGING_VERSIONS", - "CAN_EDIT", - "CAN_READ" - ] - }, - "pipelines.AutoFullRefreshPolicy": { - "type": "object", - "description": "Policy for auto full refresh.", - "properties": { - "enabled": { - "description": "[Public Preview] (Required, Mutable) Whether to enable auto full refresh or not.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.285.0" - }, - "min_interval_hours": { - "description": "[Public Preview] (Optional, Mutable) Specify the minimum interval in hours between the timestamp\nat which a table was last full refreshed and the current timestamp for triggering auto full\nIf unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours.", - "$ref": "#/$defs/int", - "x-since-version": "v0.285.0" - } - }, - "additionalProperties": false, - "required": [ - "enabled" - ] - }, - "pipelines.ConfluenceConnectorOptions": { - "type": "object", - "description": "Confluence specific options for ingestion", - "properties": { - "include_confluence_spaces": { - "description": "[Public Preview] (Optional) Spaces to filter Confluence data on", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.299.2" - } - }, - "additionalProperties": false - }, - "pipelines.ConnectionParameters": { - "type": "object", - "properties": { - "source_catalog": { - "description": "[Private Preview] Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false - }, - "pipelines.ConnectorOptions": { - "type": "object", - "description": "Wrapper message for source-specific options to support multiple connector types", - "properties": { - "confluence_options": { - "description": "[Public Preview] Confluence specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions", - "x-since-version": "v0.299.2" - }, - "gdrive_options": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "google_ads_options": { - "description": "[Private Preview] Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "jira_options": { - "description": "[Beta] Jira specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", - "x-since-version": "v0.299.2" - }, - "kafka_options": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "meta_ads_options": { - "description": "[Beta] Meta Marketing (Meta Ads) specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", - "x-since-version": "v0.299.2" - }, - "outlook_options": { - "description": "[Private Preview] Outlook specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "sharepoint_options": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "smartsheet_options": { - "description": "[Private Preview] Smartsheet specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "tiktok_ads_options": { - "description": "[Private Preview] TikTok Ads specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "zendesk_support_options": { - "description": "[Private Preview] Zendesk Support specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - } - }, - "additionalProperties": false - }, - "pipelines.ConnectorType": { - "type": "string", - "description": "For certain database sources LakeFlow Connect offers both query based and cdc\ningestion, ConnectorType can bse used to convey the type of ingestion.\nIf connection_name is provided for database sources, we default to Query Based ingestion", - "enum": [ - "CDC", - "QUERY_BASED" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]" - ] - }, - "pipelines.CronTrigger": { - "type": "object", - "properties": { - "quartz_cron_schedule": { - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "timezone_id": { - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "pipelines.DataStagingOptions": { - "type": "object", - "description": "Location of staged data storage", - "properties": { - "catalog_name": { - "description": "[Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location.", - "$ref": "#/$defs/string", - "x-since-version": "v0.296.0" - }, - "schema_name": { - "description": "[Beta] (Required, Immutable) The name of the schema for the connector's staging storage location.", - "$ref": "#/$defs/string", - "x-since-version": "v0.296.0" - }, - "volume_name": { - "description": "[Beta] (Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", - "$ref": "#/$defs/string", - "x-since-version": "v0.296.0" - } - }, - "additionalProperties": false, - "required": [ - "catalog_name", - "schema_name" - ] - }, - "pipelines.DayOfWeek": { - "type": "string", - "description": "Days of week in which the window is allowed to happen.\nIf not specified all days of the week will be used.", - "enum": [ - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY", - "SUNDAY" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "pipelines.DeploymentKind": { - "type": "string", - "description": "The deployment method that manages the pipeline:\n- BUNDLE: The pipeline is managed by a Databricks Asset Bundle.", - "enum": [ - "BUNDLE" - ] - }, - "pipelines.EventLogSpec": { - "type": "object", - "description": "Configurable event log parameters.", - "properties": { - "catalog": { - "description": "The UC catalog the event log is published under.", - "$ref": "#/$defs/string", - "x-since-version": "v0.246.0" - }, - "name": { - "description": "The name the event log is published to in UC.", - "$ref": "#/$defs/string", - "x-since-version": "v0.246.0" - }, - "schema": { - "description": "The UC schema the event log is published under.", - "$ref": "#/$defs/string", - "x-since-version": "v0.246.0" - } - }, - "additionalProperties": false - }, - "pipelines.FileFilter": { - "type": "object", - "properties": { - "modified_after": { - "description": "[Private Preview] Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "modified_before": { - "description": "[Private Preview] Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "path_filter": { - "description": "[Private Preview] Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false - }, - "pipelines.FileIngestionOptions": { - "type": "object", - "properties": { - "corrupt_record_column": { - "description": "[Private Preview]", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "file_filters": { - "description": "[Private Preview] Generic options", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "format": { - "description": "[Private Preview] required for TableSpec", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "format_options": { - "description": "[Private Preview] Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", - "$ref": "#/$defs/map/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "ignore_corrupt_files": { - "description": "[Private Preview]", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "infer_column_types": { - "description": "[Private Preview]", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "reader_case_sensitive": { - "description": "[Private Preview] Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "rescued_data_column": { - "description": "[Private Preview]", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "schema_evolution_mode": { - "description": "[Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "schema_hints": { - "description": "[Private Preview] Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "single_variant_column": { - "description": "[Private Preview]", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false - }, - "pipelines.FileIngestionOptionsFileFormat": { - "type": "string", - "enum": [ - "BINARYFILE", - "JSON", - "CSV", - "XML", - "EXCEL", - "PARQUET", - "AVRO", - "ORC" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.FileIngestionOptionsSchemaEvolutionMode": { - "type": "string", - "description": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", - "enum": [ - "ADD_NEW_COLUMNS_WITH_TYPE_WIDENING", - "ADD_NEW_COLUMNS", - "RESCUE", - "FAIL_ON_NEW_COLUMNS", - "NONE" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.FileLibrary": { - "type": "object", - "properties": { - "path": { - "description": "The absolute path of the source code.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "pipelines.Filters": { - "type": "object", - "properties": { - "exclude": { - "description": "Paths to exclude.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "include": { - "description": "Paths to include.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "pipelines.GoogleAdsConfig": { - "type": "object", - "properties": { - "manager_account_id": { - "description": "[Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - } - }, - "additionalProperties": false - }, - "pipelines.GoogleAdsOptions": { - "type": "object", - "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", - "properties": { - "lookback_window_days": { - "description": "[Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", - "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "manager_account_id": { - "description": "[Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "sync_start_date": { - "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false, - "required": [ - "manager_account_id" - ] - }, - "pipelines.GoogleDriveOptions": { - "type": "object", - "properties": { - "entity_type": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "file_ingestion_options": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "url": { - "description": "[Private Preview] Google Drive URL.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false - }, - "pipelines.GoogleDriveOptionsGoogleDriveEntityType": { - "type": "string", - "enum": [ - "FILE", - "FILE_METADATA", - "PERMISSION" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.IngestionConfig": { - "type": "object", - "properties": { - "report": { - "description": "[Public Preview] Select a specific source report.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec", - "x-since-version": "v0.231.0" - }, - "schema": { - "description": "[Public Preview] Select all tables from a specific source schema.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec", - "x-since-version": "v0.229.0" - }, - "table": { - "description": "[Public Preview] Select a specific source table.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "pipelines.IngestionGatewayPipelineDefinition": { - "type": "object", - "properties": { - "connection_id": { - "description": "[Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.229.0", - "deprecated": true - }, - "connection_name": { - "description": "[Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.234.0" - }, - "connection_parameters": { - "description": "[Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.279.0" - }, - "gateway_storage_catalog": { - "description": "[Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - }, - "gateway_storage_name": { - "description": "[Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - }, - "gateway_storage_schema": { - "description": "[Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "connection_name", - "gateway_storage_catalog", - "gateway_storage_schema" - ] - }, - "pipelines.IngestionPipelineDefinition": { - "type": "object", - "properties": { - "connection_name": { - "description": "[Public Preview] The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with\nboth connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle,\n(connector_type = QUERY_BASED OR connector_type = CDC).\nIf connection name corresponds to database connectors like Oracle, and connector_type is not provided then\nconnector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion\npipeline.\nUnder certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed\nIngestion Pipeline with Gateway pipeline.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "connector_type": { - "description": "[Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", - "x-since-version": "v0.296.0" - }, - "data_staging_options": { - "description": "[Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions", - "x-since-version": "v0.296.0" - }, - "full_refresh_window": { - "description": "[Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow", - "x-since-version": "v0.285.0" - }, - "ingest_from_uc_foreign_catalog": { - "description": "[Public Preview] Immutable. If set to true, the pipeline will ingest tables from the\nUC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.\nThe `source_catalog` fields in objects of IngestionConfig are interpreted as\nthe UC foreign catalogs to ingest from.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.279.0" - }, - "ingestion_gateway_id": { - "description": "[Public Preview] Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database.\nThis is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC).\nUnder certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc\nManaged Ingestion Pipeline.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "netsuite_jar_path": { - "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, - "x-since-version": "v0.271.0" - }, - "objects": { - "description": "[Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig", - "x-since-version": "v0.229.0" - }, - "source_configurations": { - "description": "[Public Preview] Top-level source configurations", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig", - "x-since-version": "v0.267.0" - }, - "table_configuration": { - "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig": { - "type": "object", - "description": "Configurations that are only applicable for query-based ingestion connectors.", - "properties": { - "cursor_columns": { - "description": "[Public Preview] The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.264.0" - }, - "deletion_condition": { - "description": "[Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted.\nThis is sometimes referred to as \"soft-deletes\".\nFor example: \"Operation = 'DELETE'\" or \"is_deleted = true\".\nThis field is orthogonal to `hard_deletion_sync_interval_in_seconds`,\none for soft-deletes and the other for hard-deletes.\nSee also the hard_deletion_sync_min_interval_in_seconds field for\nhandling of \"hard deletes\" where the source rows are physically removed from the table.", - "$ref": "#/$defs/string", - "x-since-version": "v0.264.0" - }, - "hard_deletion_sync_min_interval_in_seconds": { - "description": "[Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", - "$ref": "#/$defs/int64", - "x-since-version": "v0.264.0" - } - }, - "additionalProperties": false - }, - "pipelines.IngestionPipelineDefinitionWorkdayReportParameters": { - "type": "object", - "properties": { - "incremental": { - "description": "[Private Preview] (Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.271.0", - "deprecated": true - }, - "parameters": { - "description": "[Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", - "$ref": "#/$defs/map/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.271.0" - }, - "report_parameters": { - "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.271.0", - "deprecated": true - } - }, - "additionalProperties": false - }, - "pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue": { - "type": "object", - "properties": { - "key": { - "description": "[Private Preview] Key for the report parameter, can be a column name or other metadata", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.271.0" - }, - "value": { - "description": "[Private Preview] Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.271.0" - } - }, - "additionalProperties": false - }, - "pipelines.IngestionSourceType": { - "type": "string", - "enum": [ - "MYSQL", - "POSTGRESQL", - "SQLSERVER", - "SALESFORCE", - "BIGQUERY", - "NETSUITE", - "WORKDAY_RAAS", - "GA4_RAW_DATA", - "SERVICENOW", - "MANAGED_POSTGRESQL", - "ORACLE", - "TERADATA", - "SHAREPOINT", - "DYNAMICS365", - "GOOGLE_DRIVE", - "JIRA", - "CONFLUENCE", - "META_MARKETING", - "ZENDESK", - "FOREIGN_CATALOG" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Private Preview]", - "[Beta]", - "[Public Preview]", - "[Beta]", - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.JiraConnectorOptions": { - "type": "object", - "description": "Jira specific options for ingestion", - "properties": { - "include_jira_spaces": { - "description": "[Beta] (Optional) Projects to filter Jira data on", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.299.2" - } - }, - "additionalProperties": false - }, - "pipelines.JsonTransformerOptions": { - "type": "object", - "properties": { - "as_variant": { - "description": "[Private Preview] Parse the entire value as a single Variant column.", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "schema": { - "description": "[Private Preview] Inline schema string for JSON parsing (Spark DDL format).", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "schema_evolution_mode": { - "description": "[Private Preview] (Optional) Schema evolution mode for schema inference.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "schema_file_path": { - "description": "[Private Preview] Path to a schema file (.ddl).", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "schema_hints": { - "description": "[Private Preview] (Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - } - }, - "additionalProperties": false - }, - "pipelines.KafkaOptions": { - "type": "object", - "properties": { - "client_config": { - "description": "[Private Preview] Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", - "$ref": "#/$defs/map/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "key_transformer": { - "description": "[Private Preview] (Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "max_offsets_per_trigger": { - "description": "[Private Preview] Internal option to control the maximum number of offsets to process per trigger.", - "$ref": "#/$defs/int64", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "starting_offset": { - "description": "[Private Preview] (Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "topic_pattern": { - "description": "[Private Preview] Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "topics": { - "description": "[Private Preview] Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "value_transformer": { - "description": "[Private Preview] (Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - } - }, - "additionalProperties": false - }, - "pipelines.ManualTrigger": { - "type": "object", - "additionalProperties": false - }, - "pipelines.MetaMarketingOptions": { - "type": "object", - "description": "Meta Marketing (Meta Ads) specific options for ingestion", - "properties": { - "action_attribution_windows": { - "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.action_attribution_windows) Action attribution\nwindows for insights reporting (e.g. \"28d_click\", \"1d_view\")", - "$ref": "#/$defs/slice/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.299.2", - "deprecated": true - }, - "action_breakdowns": { - "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.action_breakdowns) Action breakdowns", - "$ref": "#/$defs/slice/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.299.2", - "deprecated": true - }, - "action_report_time": { - "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.action_report_time) Timing used to report\naction statistics (impression, conversion, mixed, or lifetime)", - "$ref": "#/$defs/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.299.2", - "deprecated": true - }, - "breakdowns": { - "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.breakdowns) Breakdowns to configure", - "$ref": "#/$defs/slice/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.299.2", - "deprecated": true - }, - "custom_insights_lookback_window": { - "description": "[Beta] (Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API, shared by prebuilt and custom reports.", - "$ref": "#/$defs/int", - "x-since-version": "v0.299.2" - }, - "level": { - "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.level) Granularity of data to pull\n(account, ad, adset, campaign)", - "$ref": "#/$defs/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.299.2", - "deprecated": true - }, - "start_date": { - "description": "[Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested, shared by prebuilt and custom reports.", - "$ref": "#/$defs/string", - "x-since-version": "v0.299.2" - }, - "time_increment": { - "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.time_increment) Value in string by which to\naggregate statistics (can take all_days, monthly or number of days)", - "$ref": "#/$defs/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.299.2", - "deprecated": true - } - }, - "additionalProperties": false - }, - "pipelines.NotebookLibrary": { - "type": "object", - "properties": { - "path": { - "description": "The absolute path of the source code.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "pipelines.Notifications": { - "type": "object", - "properties": { - "alerts": { - "description": "A list of alerts that trigger the sending of notifications to the configured\ndestinations. The supported alerts are:\n\n* `on-update-success`: A pipeline update completes successfully.\n* `on-update-failure`: Each time a pipeline update fails.\n* `on-update-fatal-failure`: A pipeline update fails with a non-retryable (fatal) error.\n* `on-flow-failure`: A single data flow fails.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "email_recipients": { - "description": "A list of email addresses notified when a configured alert is triggered.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "pipelines.OperationTimeWindow": { - "type": "object", - "description": "Proto representing a window", - "properties": { - "days_of_week": { - "description": "[Public Preview] Days of week in which the window is allowed to happen\nIf not specified all days of the week will be used.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", - "x-since-version": "v0.285.0" - }, - "start_hour": { - "description": "[Public Preview] An integer between 0 and 23 denoting the start hour for the window in the 24-hour day.", - "$ref": "#/$defs/int", - "x-since-version": "v0.285.0" - }, - "time_zone_id": { - "description": "[Public Preview] Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.285.0" - } - }, - "additionalProperties": false, - "required": [ - "start_hour" - ] - }, - "pipelines.OutlookAttachmentMode": { - "type": "string", - "description": "Attachment behavior mode for Outlook ingestion", - "enum": [ - "ALL", - "NON_INLINE_ONLY", - "INLINE_ONLY", - "NONE" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.OutlookBodyFormat": { - "type": "string", - "description": "Body format for Outlook email content", - "enum": [ - "TEXT_HTML", - "TEXT_PLAIN" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.OutlookOptions": { - "type": "object", - "description": "Outlook specific options for ingestion", - "properties": { - "attachment_mode": { - "description": "[Private Preview] (Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "body_format": { - "description": "[Private Preview] (Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "folder_filter": { - "description": "[Private Preview] Deprecated. Use include_folders instead.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.299.2", - "deprecated": true - }, - "include_folders": { - "description": "[Private Preview] (Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "include_mailboxes": { - "description": "[Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "include_senders": { - "description": "[Private Preview] (Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "include_subjects": { - "description": "[Private Preview] (Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "sender_filter": { - "description": "[Private Preview] Deprecated. Use include_senders instead.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.299.2", - "deprecated": true - }, - "start_date": { - "description": "[Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - }, - "subject_filter": { - "description": "[Private Preview] Deprecated. Use include_subjects instead.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.299.2", - "deprecated": true - } - }, - "additionalProperties": false - }, - "pipelines.PathPattern": { - "type": "object", - "properties": { - "include": { - "description": "[Public Preview] The source code to include for pipelines", - "$ref": "#/$defs/string", - "x-since-version": "v0.252.0" - } - }, - "additionalProperties": false - }, - "pipelines.PipelineCluster": { - "type": "object", - "properties": { - "apply_policy_default_values": { - "description": "Note: This field won't be persisted. Only API users will check this field.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "autoscale": { - "description": "Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineClusterAutoscale", - "x-since-version": "v0.229.0" - }, - "aws_attributes": { - "description": "Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes", - "x-since-version": "v0.229.0" - }, - "azure_attributes": { - "description": "Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes", - "x-since-version": "v0.229.0" - }, - "cluster_log_conf": { - "description": "The configuration for delivering spark logs to a long-term storage destination.\nOnly dbfs destinations are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf", - "x-since-version": "v0.229.0" - }, - "custom_tags": { - "description": "Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "driver_instance_pool_id": { - "description": "The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "driver_node_type_id": { - "description": "The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "enable_local_disk_encryption": { - "description": "Whether to enable local disk encryption for the cluster.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "gcp_attributes": { - "description": "Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes", - "x-since-version": "v0.229.0" - }, - "init_scripts": { - "description": "The configuration for storing init scripts. Any number of destinations can be specified. The scripts are executed sequentially in the order provided. If `cluster_log_conf` is specified, init script logs are sent to `\u003cdestination\u003e/\u003ccluster-ID\u003e/init_scripts`.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo", - "x-since-version": "v0.229.0" - }, - "instance_pool_id": { - "description": "The optional ID of the instance pool to which the cluster belongs.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "label": { - "description": "A label for the cluster specification, either `default` to configure the default cluster, or `maintenance` to configure the maintenance cluster. This field is optional. The default value is `default`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "node_type_id": { - "description": "This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "num_workers": { - "description": "Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "policy_id": { - "description": "The ID of the cluster policy used to create the cluster if applicable.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "spark_conf": { - "description": "An object containing a set of optional, user-specified Spark configuration key-value pairs.\nSee :method:clusters/create for more details.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "spark_env_vars": { - "description": "An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "ssh_public_keys": { - "description": "SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "pipelines.PipelineClusterAutoscale": { - "type": "object", - "properties": { - "max_workers": { - "description": "The maximum number of workers to which the cluster can scale up when overloaded. `max_workers` must be strictly greater than `min_workers`.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "min_workers": { - "description": "The minimum number of workers the cluster can scale down to when underutilized.\nIt is also the initial number of workers the cluster will have after creation.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "mode": { - "description": "Databricks Enhanced Autoscaling optimizes cluster utilization by automatically\nallocating cluster resources based on workload volume, with minimal impact to\nthe data processing latency of your pipelines. Enhanced Autoscaling is available\nfor `updates` clusters only. The legacy autoscaling feature is used for `maintenance`\nclusters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineClusterAutoscaleMode", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "max_workers", - "min_workers" - ] - }, - "pipelines.PipelineClusterAutoscaleMode": { - "type": "string", - "description": "Databricks Enhanced Autoscaling optimizes cluster utilization by automatically\nallocating cluster resources based on workload volume, with minimal impact to\nthe data processing latency of your pipelines. Enhanced Autoscaling is available\nfor `updates` clusters only. The legacy autoscaling feature is used for `maintenance`\nclusters.", - "enum": [ - "ENHANCED", - "LEGACY" - ] - }, - "pipelines.PipelineDeployment": { - "type": "object", - "properties": { - "kind": { - "description": "The deployment method that manages the pipeline.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind", - "x-since-version": "v0.229.0" - }, - "metadata_file_path": { - "description": "The path to the file containing metadata about the deployment.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "kind" - ] - }, - "pipelines.PipelineLibrary": { - "type": "object", - "properties": { - "file": { - "description": "The path to a file that defines a pipeline and is stored in the Databricks Repos.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileLibrary", - "x-since-version": "v0.229.0" - }, - "glob": { - "description": "[Public Preview] The unified field to include source codes.\nEach entry can be a notebook path, a file path, or a folder path that ends `/**`.\nThis field cannot be used together with `notebook` or `file`.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern", - "x-since-version": "v0.252.0" - }, - "jar": { - "description": "[Private Preview] URI of the jar to be installed. Currently only DBFS is supported.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - }, - "maven": { - "description": "[Private Preview] Specification of a maven library to be installed.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - }, - "notebook": { - "description": "The path to a notebook that defines a pipeline and is stored in the Databricks workspace.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.NotebookLibrary", - "x-since-version": "v0.229.0" - }, - "whl": { - "description": "URI of the whl to be installed.", - "$ref": "#/$defs/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - } - }, - "additionalProperties": false - }, - "pipelines.PipelinePermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "IS_OWNER", - "CAN_RUN", - "CAN_VIEW" - ] - }, - "pipelines.PipelineTrigger": { - "type": "object", - "properties": { - "cron": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.CronTrigger", - "x-since-version": "v0.229.0" - }, - "manual": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "pipelines.PipelinesEnvironment": { - "type": "object", - "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 dependencies are supported.", - "properties": { - "dependencies": { - "description": "[Public Preview] List of pip dependencies, as supported by the version of pip in this environment.\nEach dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/\nAllowed dependency could be \u003crequirement specifier\u003e, \u003carchive url/path\u003e, \u003clocal project path\u003e(WSFS or Volumes in Databricks), \u003cvcs project url\u003e", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.257.0" - }, - "environment_version": { - "description": "[Private Preview] The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.294.0" - } - }, - "additionalProperties": false - }, - "pipelines.PostgresCatalogConfig": { - "type": "object", - "description": "PG-specific catalog-level configuration parameters", - "properties": { - "slot_config": { - "description": "[Public Preview] Optional. The Postgres slot configuration to use for logical replication", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig", - "x-since-version": "v0.267.0" - } - }, - "additionalProperties": false - }, - "pipelines.PostgresSlotConfig": { - "type": "object", - "description": "PostgresSlotConfig contains the configuration for a Postgres logical replication slot", - "properties": { - "publication_name": { - "description": "[Public Preview] The name of the publication to use for the Postgres source", - "$ref": "#/$defs/string", - "x-since-version": "v0.267.0" - }, - "slot_name": { - "description": "[Public Preview] The name of the logical replication slot to use for the Postgres source", - "$ref": "#/$defs/string", - "x-since-version": "v0.267.0" - } - }, - "additionalProperties": false - }, - "pipelines.ReportSpec": { - "type": "object", - "properties": { - "destination_catalog": { - "description": "[Public Preview] Required. Destination catalog to store table.", - "$ref": "#/$defs/string", - "x-since-version": "v0.231.0" - }, - "destination_schema": { - "description": "[Public Preview] Required. Destination schema to store table.", - "$ref": "#/$defs/string", - "x-since-version": "v0.231.0" - }, - "destination_table": { - "description": "[Public Preview] Required. Destination table name. The pipeline fails if a table with that name already exists.", - "$ref": "#/$defs/string", - "x-since-version": "v0.231.0" - }, - "source_url": { - "description": "[Public Preview] Required. Report URL in the source system.", - "$ref": "#/$defs/string", - "x-since-version": "v0.231.0" - }, - "table_configuration": { - "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", - "x-since-version": "v0.231.0" - } - }, - "additionalProperties": false, - "required": [ - "destination_catalog", - "destination_schema", - "source_url" - ] - }, - "pipelines.RestartWindow": { - "type": "object", - "properties": { - "days_of_week": { - "description": "[Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.234.0" - }, - "start_hour": { - "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", - "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.234.0" - }, - "time_zone_id": { - "description": "[Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.234.0" - } - }, - "additionalProperties": false, - "required": [ - "start_hour" - ] - }, - "pipelines.RunAs": { - "type": "object", - "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.", - "properties": { - "service_principal_name": { - "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", - "$ref": "#/$defs/string", - "x-since-version": "v0.241.0" - }, - "user_name": { - "description": "The email of an active workspace user. Users can only set this field to their own email.", - "$ref": "#/$defs/string", - "x-since-version": "v0.241.0" - } - }, - "additionalProperties": false - }, - "pipelines.SchemaSpec": { - "type": "object", - "properties": { - "connector_options": { - "description": "[Public Preview] (Optional) Source Specific Connector Options", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", - "x-since-version": "v0.298.0" - }, - "destination_catalog": { - "description": "[Public Preview] Required. Destination catalog to store tables.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "destination_schema": { - "description": "[Public Preview] Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "source_catalog": { - "description": "[Public Preview] The source catalog name. Might be optional depending on the type of source.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "source_schema": { - "description": "[Public Preview] Required. Schema name in the source database.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "table_configuration": { - "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "destination_catalog", - "destination_schema", - "source_schema" - ] - }, - "pipelines.SharepointOptions": { - "type": "object", - "properties": { - "entity_type": { - "description": "[Private Preview] (Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "file_ingestion_options": { - "description": "[Private Preview] (Optional) File ingestion options for processing files.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "url": { - "description": "[Private Preview] Required. The SharePoint URL.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false - }, - "pipelines.SharepointOptionsSharepointEntityType": { - "type": "string", - "enum": [ - "FILE", - "FILE_METADATA", - "PERMISSION", - "LIST" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.SmartsheetOptions": { - "type": "object", - "description": "Smartsheet specific options for ingestion", - "properties": { - "enforce_schema": { - "description": "[Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - } - }, - "additionalProperties": false - }, - "pipelines.SourceCatalogConfig": { - "type": "object", - "description": "SourceCatalogConfig contains catalog-level custom configuration parameters for each source", - "properties": { - "postgres": { - "description": "[Public Preview] Postgres-specific catalog-level configuration parameters", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig", - "x-since-version": "v0.267.0" - }, - "source_catalog": { - "description": "[Public Preview] Source catalog name", - "$ref": "#/$defs/string", - "x-since-version": "v0.267.0" - } - }, - "additionalProperties": false - }, - "pipelines.SourceConfig": { - "type": "object", - "properties": { - "catalog": { - "description": "[Public Preview] Catalog-level source configuration parameters", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig", - "x-since-version": "v0.267.0" - }, - "google_ads_config": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - } - }, - "additionalProperties": false - }, - "pipelines.TableSpec": { - "type": "object", - "properties": { - "connector_options": { - "description": "[Public Preview] (Optional) Source Specific Connector Options", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", - "x-since-version": "v0.298.0" - }, - "destination_catalog": { - "description": "[Public Preview] Required. Destination catalog to store table.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "destination_schema": { - "description": "[Public Preview] Required. Destination schema to store table.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "destination_table": { - "description": "[Public Preview] Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "source_catalog": { - "description": "[Public Preview] Source catalog name. Might be optional depending on the type of source.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "source_schema": { - "description": "[Public Preview] Schema name in the source database. Might be optional depending on the type of source.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "source_table": { - "description": "[Public Preview] Required. Table name in the source database.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "table_configuration": { - "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "destination_catalog", - "destination_schema", - "source_table" - ] - }, - "pipelines.TableSpecificConfig": { - "type": "object", - "properties": { - "auto_full_refresh_policy": { - "description": "[Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy", - "x-since-version": "v0.285.0" - }, - "clustering_columns": { - "description": "[Private Preview] List of column names to use for clustering the destination table.\nWhen specified, the destination Delta table will be clustered by these columns.\nThis can improve query performance when filtering on these columns.\nNote: clustering_columns in table specific configuration will override the pipeline definition.\nNote: we can only provide enable_auto_clustering or clustering_columns,\nadded as separate fields as we cannot have repeated field in oneof.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - }, - "enable_auto_clustering": { - "description": "[Private Preview] Whether to enable auto clustering on the destination table.\nWhen enabled, Delta will automatically optimize the data layout\nbased on the clustering columns for improved query performance.\nNote: enable_auto_clustering in table specific configuration will override the pipeline definition.\nNote: we can only provide enable_auto_clustering or clustering_columns,\nadded as separate fields as we cannot have repeated field in oneof.", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - }, - "exclude_columns": { - "description": "[Public Preview] A list of column names to be excluded for the ingestion.\nWhen not specified, include_columns fully controls what columns to be ingested.\nWhen specified, all other columns including future ones will be automatically included for ingestion.\nThis field in mutually exclusive with `include_columns`.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.251.0" - }, - "include_columns": { - "description": "[Public Preview] A list of column names to be included for the ingestion.\nWhen not specified, all columns except ones in exclude_columns will be included. Future\ncolumns will be automatically included.\nWhen specified, all other future columns will be automatically excluded from ingestion.\nThis field in mutually exclusive with `exclude_columns`.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.251.0" - }, - "primary_keys": { - "description": "[Public Preview] The primary key of the table used to apply changes.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.229.0" - }, - "query_based_connector_config": { - "description": "[Public Preview] Configurations that are only applicable for query-based ingestion connectors.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", - "x-since-version": "v0.264.0" - }, - "row_filter": { - "description": "[Public Preview] (Optional, Immutable) The row filter condition to be applied to the table.\nIt must not contain the WHERE keyword, only the actual filter condition.\nIt must be in DBSQL format.", - "$ref": "#/$defs/string", - "x-since-version": "v0.283.0" - }, - "salesforce_include_formula_fields": { - "description": "[Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.229.0" - }, - "scd_type": { - "description": "[Public Preview] The SCD type to use to ingest the table.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType", - "x-since-version": "v0.229.0" - }, - "sequence_by": { - "description": "[Public Preview] The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.231.0" - }, - "table_properties": { - "description": "[Private Preview] Table properties to set on the destination table.\nThese are key-value pairs that configure various Delta table behaviors or any user defined properties.\nExample: {\"delta.feature.variantType\": \"supported\", \"delta.enableTypeWidening\": \"true\"}\nNote: table_properties in table specific configuration will override the table_properties of the pipeline definition.", - "$ref": "#/$defs/map/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - }, - "workday_report_parameters": { - "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, - "x-since-version": "v0.271.0" - } - }, - "additionalProperties": false - }, - "pipelines.TableSpecificConfigScdType": { - "type": "string", - "description": "The SCD type to use to ingest the table.", - "enum": [ - "SCD_TYPE_1", - "SCD_TYPE_2", - "APPEND_ONLY" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "pipelines.TikTokAdsOptions": { - "type": "object", - "description": "TikTok Ads specific options for ingestion", - "properties": { - "data_level": { - "description": "[Private Preview] Deprecated. Use custom_report_options.data_level instead.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.298.0", - "deprecated": true - }, - "dimensions": { - "description": "[Private Preview] Deprecated. Use custom_report_options.dimensions instead.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.298.0", - "deprecated": true - }, - "lookback_window_days": { - "description": "[Private Preview] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.", - "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - }, - "metrics": { - "description": "[Private Preview] Deprecated. Use custom_report_options.metrics instead.", - "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.298.0", - "deprecated": true - }, - "query_lifetime": { - "description": "[Private Preview] Deprecated. Use custom_report_options.query_lifetime instead.", - "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.298.0", - "deprecated": true - }, - "report_type": { - "description": "[Private Preview] Deprecated. Use custom_report_options.report_type instead.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "deprecationMessage": "This field is deprecated", - "doNotSuggest": true, - "x-since-version": "v0.298.0", - "deprecated": true - }, - "sync_start_date": { - "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.298.0" - } - }, - "additionalProperties": false - }, - "pipelines.TikTokAdsOptionsTikTokDataLevel": { - "type": "string", - "description": "Data level for TikTok Ads report aggregation.", - "enum": [ - "AUCTION_ADVERTISER", - "AUCTION_CAMPAIGN", - "AUCTION_ADGROUP", - "AUCTION_AD" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.TikTokAdsOptionsTikTokReportType": { - "type": "string", - "description": "Report type for TikTok Ads API.", - "enum": [ - "BASIC", - "AUDIENCE", - "PLAYABLE_AD", - "DSA", - "BUSINESS_CENTER", - "GMV_MAX" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.Transformer": { - "type": "object", - "description": "Specifies how to transform binary data into structured data.", - "properties": { - "format": { - "description": "[Private Preview] Required: the wire format of the data.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - }, - "json_options": { - "description": "[Private Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.1.0" - } - }, - "additionalProperties": false - }, - "pipelines.TransformerFormat": { - "type": "string", - "enum": [ - "STRING", - "JSON" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]" - ] - }, - "pipelines.ZendeskSupportOptions": { - "type": "object", - "description": "Zendesk Support specific options for ingestion", - "properties": { - "start_date": { - "description": "[Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v0.299.2" - } - }, - "additionalProperties": false - }, - "postgres.EndpointGroupSpec": { - "type": "object", - "properties": { - "enable_readable_secondaries": { - "description": "[Beta] Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.290.0" - }, - "max": { - "description": "[Beta] The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec.", - "$ref": "#/$defs/int", - "x-since-version": "v0.290.0" - }, - "min": { - "description": "[Beta] The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1.", - "$ref": "#/$defs/int", - "x-since-version": "v0.290.0" - } - }, - "additionalProperties": false, - "required": [ - "max", - "min" - ] - }, - "postgres.EndpointSettings": { - "type": "object", - "description": "A collection of settings for a compute endpoint.", - "properties": { - "pg_settings": { - "description": "[Beta] A raw representation of Postgres settings.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.287.0" - } - }, - "additionalProperties": false - }, - "postgres.EndpointType": { - "type": "string", - "description": "The compute endpoint type. Either `read_write` or `read_only`.", - "enum": [ - "ENDPOINT_TYPE_READ_WRITE", - "ENDPOINT_TYPE_READ_ONLY" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]" - ] - }, - "postgres.NewPipelineSpec": { - "type": "object", - "properties": { - "budget_policy_id": { - "description": "[Beta] Budget policy to set on the newly created pipeline.", - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "storage_catalog": { - "description": "[Beta] UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - }, - "storage_schema": { - "description": "[Beta] UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", - "$ref": "#/$defs/string", - "x-since-version": "v1.0.0" - } - }, - "additionalProperties": false - }, - "postgres.ProjectCustomTag": { - "type": "object", - "properties": { - "key": { - "description": "[Beta] The key of the custom tag.", - "$ref": "#/$defs/string", - "x-since-version": "v0.290.0" - }, - "value": { - "description": "[Beta] The value of the custom tag.", - "$ref": "#/$defs/string", - "x-since-version": "v0.290.0" - } - }, - "additionalProperties": false - }, - "postgres.ProjectDefaultEndpointSettings": { - "type": "object", - "description": "A collection of settings for a compute endpoint.", - "properties": { - "autoscaling_limit_max_cu": { - "description": "[Beta] The maximum number of Compute Units. Minimum value is 0.5.", - "$ref": "#/$defs/float64", - "x-since-version": "v0.287.0" - }, - "autoscaling_limit_min_cu": { - "description": "[Beta] The minimum number of Compute Units. Minimum value is 0.5.", - "$ref": "#/$defs/float64", - "x-since-version": "v0.287.0" - }, - "no_suspension": { - "description": "[Beta] When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.287.0" - }, - "pg_settings": { - "description": "[Beta] A raw representation of Postgres settings.", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.287.0" - }, - "suspend_timeout_duration": { - "description": "[Beta] Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", - "x-since-version": "v0.287.0" - } - }, - "additionalProperties": false - }, - "postgres.RoleAttributes": { - "type": "object", - "description": "Attributes that can be granted to a Postgres role. We are only implementing a subset for now, see xref:\nhttps://www.postgresql.org/docs/16/sql-createrole.html\nThe values follow Postgres keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical\nunderscores between words.", - "properties": { - "bypassrls": { - "description": "[Beta]", - "$ref": "#/$defs/bool", - "x-since-version": "v1.4.0" - }, - "createdb": { - "description": "[Beta]", - "$ref": "#/$defs/bool", - "x-since-version": "v1.4.0" - }, - "createrole": { - "description": "[Beta]", - "$ref": "#/$defs/bool", - "x-since-version": "v1.4.0" - } - }, - "additionalProperties": false - }, - "postgres.RoleAuthMethod": { - "type": "string", - "description": "How the role is authenticated when connecting to Postgres.", - "enum": [ - "NO_LOGIN", - "PG_PASSWORD_SCRAM_SHA_256", - "LAKEBASE_OAUTH_V1" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]" - ] - }, - "postgres.RoleIdentityType": { - "type": "string", - "description": "The type of the Databricks managed identity that this Role represents.\nLeave empty if you wish to create a regular Postgres role not associated with a Databricks identity.", - "enum": [ - "USER", - "SERVICE_PRINCIPAL", - "GROUP" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]" - ] - }, - "postgres.RoleMembershipRole": { - "type": "string", - "description": "Roles that the DatabaseInstanceRole can be a member of.", - "enum": [ - "DATABRICKS_SUPERUSER" - ], - "enumDescriptions": [ - "[Beta]" - ] - }, - "postgres.SyncedTableSyncedTableSpecPgSpecificType": { - "type": "string", - "description": "PostgreSQL-specific target types that can override the default Delta-to-PG mapping.", - "enum": [ - "PG_SPECIFIC_TYPE_VECTOR" - ], - "enumDescriptions": [ - "[Private Preview]" - ] - }, - "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy": { - "type": "string", - "description": "Scheduling policy of the synced table's underlying pipeline.", - "enum": [ - "CONTINUOUS", - "TRIGGERED", - "SNAPSHOT" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]" - ] - }, - "postgres.SyncedTableSyncedTableSpecTypeOverride": { - "type": "object", - "description": "Overrides the default Delta-to-PostgreSQL type mapping for a single column.", - "properties": { - "column_name": { - "description": "[Private Preview] Name of the source column whose target PostgreSQL type should be overridden.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - }, - "pg_type": { - "description": "[Private Preview] PostgreSQL-specific target type to use for the column.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecPgSpecificType", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - }, - "size": { - "description": "[Private Preview] Size parameter for the target type. Required when pg_type is PG_SPECIFIC_TYPE_VECTOR\n(specifies the vector dimension, e.g., 1024).", - "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true - } - }, - "additionalProperties": false, - "required": [ - "column_name", - "pg_type" - ] - }, - "serving.Ai21LabsConfig": { - "type": "object", - "properties": { - "ai21labs_api_key": { - "description": "The Databricks secret key reference for an AI21 Labs API key. If you\nprefer to paste your API key directly, see `ai21labs_api_key_plaintext`.\nYou must provide an API key using one of the following fields:\n`ai21labs_api_key` or `ai21labs_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "ai21labs_api_key_plaintext": { - "description": "An AI21 Labs API key provided as a plaintext string. If you prefer to\nreference your key using Databricks Secrets, see `ai21labs_api_key`. You\nmust provide an API key using one of the following fields:\n`ai21labs_api_key` or `ai21labs_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "serving.AiGatewayConfig": { - "type": "object", - "properties": { - "fallback_config": { - "description": "Configuration for traffic fallback which auto fallbacks to other served entities if the request to a served\nentity fails with certain error codes, to increase availability.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.FallbackConfig", - "x-since-version": "v0.246.0" - }, - "guardrails": { - "description": "[Public Preview] Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails", - "x-since-version": "v0.230.0" - }, - "inference_table_config": { - "description": "Configuration for payload logging using inference tables.\nUse these tables to monitor and audit data being sent to and received from model APIs and to improve model quality.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayInferenceTableConfig", - "x-since-version": "v0.230.0" - }, - "rate_limits": { - "description": "Configuration for rate limits which can be set to limit endpoint traffic.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimit", - "x-since-version": "v0.230.0" - }, - "usage_tracking_config": { - "description": "Configuration to enable usage tracking using system tables.\nThese tables allow you to monitor operational usage on endpoints and their associated costs.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayUsageTrackingConfig", - "x-since-version": "v0.230.0" - } - }, - "additionalProperties": false - }, - "serving.AiGatewayGuardrailParameters": { - "type": "object", - "properties": { - "invalid_keywords": { - "description": "[Public Preview] List of invalid keywords.\nAI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.", - "$ref": "#/$defs/slice/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.230.0", - "deprecated": true - }, - "pii": { - "description": "[Public Preview] Configuration for guardrail PII filter.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior", - "x-since-version": "v0.230.0" - }, - "safety": { - "description": "[Public Preview] Indicates whether the safety filter is enabled.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.230.0" - }, - "valid_topics": { - "description": "[Public Preview] The list of allowed topics.\nGiven a chat request, this guardrail flags the request if its topic is not in the allowed topics.", - "$ref": "#/$defs/slice/string", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.230.0", - "deprecated": true - } - }, - "additionalProperties": false - }, - "serving.AiGatewayGuardrailPiiBehavior": { - "type": "object", - "properties": { - "behavior": { - "description": "[Public Preview] Configuration for input guardrail filters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior", - "x-since-version": "v0.230.0" - } - }, - "additionalProperties": false - }, - "serving.AiGatewayGuardrailPiiBehaviorBehavior": { - "type": "string", - "enum": [ - "NONE", - "BLOCK", - "MASK" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "serving.AiGatewayGuardrails": { - "type": "object", - "properties": { - "input": { - "description": "[Public Preview] Configuration for input guardrail filters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", - "x-since-version": "v0.230.0" - }, - "output": { - "description": "[Public Preview] Configuration for output guardrail filters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", - "x-since-version": "v0.230.0" - } - }, - "additionalProperties": false - }, - "serving.AiGatewayInferenceTableConfig": { - "type": "object", - "properties": { - "catalog_name": { - "description": "The name of the catalog in Unity Catalog. Required when enabling inference tables.\nNOTE: On update, you have to disable inference table first in order to change the catalog name.", - "$ref": "#/$defs/string", - "x-since-version": "v0.230.0" - }, - "enabled": { - "description": "Indicates whether the inference table is enabled.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.230.0" - }, - "schema_name": { - "description": "The name of the schema in Unity Catalog. Required when enabling inference tables.\nNOTE: On update, you have to disable inference table first in order to change the schema name.", - "$ref": "#/$defs/string", - "x-since-version": "v0.230.0" - }, - "table_name_prefix": { - "description": "The prefix of the table in Unity Catalog.\nNOTE: On update, you have to disable inference table first in order to change the prefix name.", - "$ref": "#/$defs/string", - "x-since-version": "v0.230.0" - } - }, - "additionalProperties": false - }, - "serving.AiGatewayRateLimit": { - "type": "object", - "properties": { - "calls": { - "description": "Used to specify how many calls are allowed for a key within the renewal_period.", - "$ref": "#/$defs/int64", - "x-since-version": "v0.230.0" - }, - "key": { - "description": "Key field for a rate limit. Currently, 'user', 'user_group, 'service_principal', and 'endpoint' are supported,\nwith 'endpoint' being the default if not specified.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitKey", - "x-since-version": "v0.230.0" - }, - "principal": { - "description": "Principal field for a user, user group, or service principal to apply rate limiting to. Accepts a user email, group name, or service principal application ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "renewal_period": { - "description": "Renewal period field for a rate limit. Currently, only 'minute' is supported.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitRenewalPeriod", - "x-since-version": "v0.230.0" - }, - "tokens": { - "description": "Used to specify how many tokens are allowed for a key within the renewal_period.", - "$ref": "#/$defs/int64", - "x-since-version": "v0.265.0" - } - }, - "additionalProperties": false, - "required": [ - "renewal_period" - ] - }, - "serving.AiGatewayRateLimitKey": { - "type": "string", - "enum": [ - "user", - "endpoint", - "user_group", - "service_principal" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "serving.AiGatewayRateLimitRenewalPeriod": { - "type": "string", - "enum": [ - "minute" - ], - "enumDescriptions": [ - "[Public Preview]" - ] - }, - "serving.AiGatewayUsageTrackingConfig": { - "type": "object", - "properties": { - "enabled": { - "description": "Whether to enable usage tracking.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.230.0" - } - }, - "additionalProperties": false - }, - "serving.AmazonBedrockConfig": { - "type": "object", - "properties": { - "aws_access_key_id": { - "description": "The Databricks secret key reference for an AWS access key ID with\npermissions to interact with Bedrock services. If you prefer to paste\nyour API key directly, see `aws_access_key_id_plaintext`. You must provide an API\nkey using one of the following fields: `aws_access_key_id` or\n`aws_access_key_id_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "aws_access_key_id_plaintext": { - "description": "An AWS access key ID with permissions to interact with Bedrock services\nprovided as a plaintext string. If you prefer to reference your key using\nDatabricks Secrets, see `aws_access_key_id`. You must provide an API key\nusing one of the following fields: `aws_access_key_id` or\n`aws_access_key_id_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "aws_region": { - "description": "The AWS region to use. Bedrock has to be enabled there.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "aws_secret_access_key": { - "description": "The Databricks secret key reference for an AWS secret access key paired\nwith the access key ID, with permissions to interact with Bedrock\nservices. If you prefer to paste your API key directly, see\n`aws_secret_access_key_plaintext`. You must provide an API key using one\nof the following fields: `aws_secret_access_key` or\n`aws_secret_access_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "aws_secret_access_key_plaintext": { - "description": "An AWS secret access key paired with the access key ID, with permissions\nto interact with Bedrock services provided as a plaintext string. If you\nprefer to reference your key using Databricks Secrets, see\n`aws_secret_access_key`. You must provide an API key using one of the\nfollowing fields: `aws_secret_access_key` or\n`aws_secret_access_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "bedrock_provider": { - "description": "The underlying provider in Amazon Bedrock. Supported values (case\ninsensitive) include: Anthropic, Cohere, AI21Labs, Amazon.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfigBedrockProvider", - "x-since-version": "v0.229.0" - }, - "instance_profile_arn": { - "description": "ARN of the instance profile that the external model will use to access AWS resources.\nYou must authenticate using an instance profile or access keys.\nIf you prefer to authenticate using access keys, see `aws_access_key_id`,\n`aws_access_key_id_plaintext`, `aws_secret_access_key` and `aws_secret_access_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.243.0" - } - }, - "additionalProperties": false, - "required": [ - "aws_region", - "bedrock_provider" - ] - }, - "serving.AmazonBedrockConfigBedrockProvider": { - "type": "string", - "enum": [ - "anthropic", - "cohere", - "ai21labs", - "amazon" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "serving.AnthropicConfig": { - "type": "object", - "properties": { - "anthropic_api_key": { - "description": "The Databricks secret key reference for an Anthropic API key. If you\nprefer to paste your API key directly, see `anthropic_api_key_plaintext`.\nYou must provide an API key using one of the following fields:\n`anthropic_api_key` or `anthropic_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "anthropic_api_key_plaintext": { - "description": "The Anthropic API key provided as a plaintext string. If you prefer to\nreference your key using Databricks Secrets, see `anthropic_api_key`. You\nmust provide an API key using one of the following fields:\n`anthropic_api_key` or `anthropic_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "serving.ApiKeyAuth": { - "type": "object", - "properties": { - "key": { - "description": "The name of the API key parameter used for authentication.", - "$ref": "#/$defs/string", - "x-since-version": "v0.246.0" - }, - "value": { - "description": "The Databricks secret key reference for an API Key.\nIf you prefer to paste your token directly, see `value_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.246.0" - }, - "value_plaintext": { - "description": "The API Key provided as a plaintext string. If you prefer to reference your\ntoken using Databricks Secrets, see `value`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.246.0" - } - }, - "additionalProperties": false, - "required": [ - "key" - ] - }, - "serving.AutoCaptureConfigInput": { - "type": "object", - "description": "Deprecated: legacy inference table configuration. Please use AI Gateway inference tables instead.\nSee https://docs.databricks.com/aws/en/ai-gateway/inference-tables.", - "properties": { - "catalog_name": { - "description": "The name of the catalog in Unity Catalog. NOTE: On update, you cannot change the catalog name if the inference table is already enabled.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "enabled": { - "description": "Indicates whether the inference table is enabled.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "schema_name": { - "description": "The name of the schema in Unity Catalog. NOTE: On update, you cannot change the schema name if the inference table is already enabled.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "table_name_prefix": { - "description": "The prefix of the table in Unity Catalog. NOTE: On update, you cannot change the prefix name if the inference table is already enabled.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "serving.BearerTokenAuth": { - "type": "object", - "properties": { - "token": { - "description": "The Databricks secret key reference for a token.\nIf you prefer to paste your token directly, see `token_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.246.0" - }, - "token_plaintext": { - "description": "The token provided as a plaintext string. If you prefer to reference your\ntoken using Databricks Secrets, see `token`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.246.0" - } - }, - "additionalProperties": false - }, - "serving.CohereConfig": { - "type": "object", - "properties": { - "cohere_api_base": { - "description": "This is an optional field to provide a customized base URL for the Cohere\nAPI. If left unspecified, the standard Cohere base URL is used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "cohere_api_key": { - "description": "The Databricks secret key reference for a Cohere API key. If you prefer\nto paste your API key directly, see `cohere_api_key_plaintext`. You must\nprovide an API key using one of the following fields: `cohere_api_key` or\n`cohere_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "cohere_api_key_plaintext": { - "description": "The Cohere API key provided as a plaintext string. If you prefer to\nreference your key using Databricks Secrets, see `cohere_api_key`. You\nmust provide an API key using one of the following fields:\n`cohere_api_key` or `cohere_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "serving.CustomProviderConfig": { - "type": "object", - "description": "Configs needed to create a custom provider model route.", - "properties": { - "api_key_auth": { - "description": "This is a field to provide API key authentication for the custom provider API.\nYou can only specify one authentication method.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ApiKeyAuth", - "x-since-version": "v0.246.0" - }, - "bearer_token_auth": { - "description": "This is a field to provide bearer token authentication for the custom provider API.\nYou can only specify one authentication method.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.BearerTokenAuth", - "x-since-version": "v0.246.0" - }, - "custom_provider_url": { - "description": "This is a field to provide the URL of the custom provider API.", - "$ref": "#/$defs/string", - "x-since-version": "v0.246.0" - } - }, - "additionalProperties": false, - "required": [ - "custom_provider_url" - ] - }, - "serving.DatabricksModelServingConfig": { - "type": "object", - "properties": { - "databricks_api_token": { - "description": "The Databricks secret key reference for a Databricks API token that\ncorresponds to a user or service principal with Can Query access to the\nmodel serving endpoint pointed to by this external model. If you prefer\nto paste your API key directly, see `databricks_api_token_plaintext`. You\nmust provide an API key using one of the following fields:\n`databricks_api_token` or `databricks_api_token_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "databricks_api_token_plaintext": { - "description": "The Databricks API token that corresponds to a user or service principal\nwith Can Query access to the model serving endpoint pointed to by this\nexternal model provided as a plaintext string. If you prefer to reference\nyour key using Databricks Secrets, see `databricks_api_token`. You must\nprovide an API key using one of the following fields:\n`databricks_api_token` or `databricks_api_token_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "databricks_workspace_url": { - "description": "The URL of the Databricks workspace containing the model serving endpoint\npointed to by this external model.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "databricks_workspace_url" - ] - }, - "serving.EmailNotifications": { - "type": "object", - "properties": { - "on_update_failure": { - "description": "A list of email addresses to be notified when an endpoint fails to update its configuration or state.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.264.0" - }, - "on_update_success": { - "description": "A list of email addresses to be notified when an endpoint successfully updates its configuration or state.", - "$ref": "#/$defs/slice/string", - "x-since-version": "v0.264.0" - } - }, - "additionalProperties": false - }, - "serving.EndpointCoreConfigInput": { - "type": "object", - "properties": { - "auto_capture_config": { - "description": "Configuration for legacy Inference Tables which automatically log requests and responses to Unity\nCatalog.\nDeprecated: please use AI Gateway inference tables instead. See\nhttps://docs.databricks.com/aws/en/ai-gateway/inference-tables.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AutoCaptureConfigInput", - "deprecationMessage": "This field is deprecated", - "x-since-version": "v0.229.0", - "deprecated": true - }, - "served_entities": { - "description": "The list of served entities under the serving endpoint config.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput", - "x-since-version": "v0.229.0" - }, - "served_models": { - "description": "(Deprecated, use served_entities instead) The list of served models under the serving endpoint config.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput", - "x-since-version": "v0.229.0" - }, - "traffic_config": { - "description": "The traffic configuration associated with the serving endpoint config.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TrafficConfig", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "serving.EndpointTag": { - "type": "object", - "properties": { - "key": { - "description": "Key field for a serving endpoint tag.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "value": { - "description": "Optional value field for a serving endpoint tag.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "key" - ] - }, - "serving.ExternalModel": { - "type": "object", - "properties": { - "ai21labs_config": { - "description": "AI21Labs Config. Only required if the provider is 'ai21labs'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig", - "x-since-version": "v0.229.0" - }, - "amazon_bedrock_config": { - "description": "Amazon Bedrock Config. Only required if the provider is 'amazon-bedrock'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfig", - "x-since-version": "v0.229.0" - }, - "anthropic_config": { - "description": "Anthropic Config. Only required if the provider is 'anthropic'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AnthropicConfig", - "x-since-version": "v0.229.0" - }, - "cohere_config": { - "description": "Cohere Config. Only required if the provider is 'cohere'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.CohereConfig", - "x-since-version": "v0.229.0" - }, - "custom_provider_config": { - "description": "Custom Provider Config. Only required if the provider is 'custom'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.CustomProviderConfig", - "x-since-version": "v0.246.0" - }, - "databricks_model_serving_config": { - "description": "Databricks Model Serving Config. Only required if the provider is 'databricks-model-serving'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.DatabricksModelServingConfig", - "x-since-version": "v0.229.0" - }, - "google_cloud_vertex_ai_config": { - "description": "Google Cloud Vertex AI Config. Only required if the provider is 'google-cloud-vertex-ai'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.GoogleCloudVertexAiConfig", - "x-since-version": "v0.229.0" - }, - "name": { - "description": "The name of the external model.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "openai_config": { - "description": "OpenAI Config. Only required if the provider is 'openai'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.OpenAiConfig", - "x-since-version": "v0.229.0" - }, - "palm_config": { - "description": "PaLM Config. Only required if the provider is 'palm'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.PaLmConfig", - "x-since-version": "v0.229.0" - }, - "provider": { - "description": "The name of the provider for the external model. Currently, the supported providers are 'ai21labs', 'anthropic', 'amazon-bedrock', 'cohere', 'databricks-model-serving', 'google-cloud-vertex-ai', 'openai', 'palm', and 'custom'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ExternalModelProvider", - "x-since-version": "v0.229.0" - }, - "task": { - "description": "The task type of the external model.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "name", - "provider", - "task" - ] - }, - "serving.ExternalModelProvider": { - "type": "string", - "enum": [ - "ai21labs", - "anthropic", - "amazon-bedrock", - "cohere", - "databricks-model-serving", - "google-cloud-vertex-ai", - "openai", - "palm", - "custom" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "serving.FallbackConfig": { - "type": "object", - "properties": { - "enabled": { - "description": "Whether to enable traffic fallback. When a served entity in the serving endpoint returns specific error\ncodes (e.g. 500), the request will automatically be round-robin attempted with other served entities in the same\nendpoint, following the order of served entity list, until a successful response is returned.\nIf all attempts fail, return the last response with the error code.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.246.0" - } - }, - "additionalProperties": false, - "required": [ - "enabled" - ] - }, - "serving.GoogleCloudVertexAiConfig": { - "type": "object", - "properties": { - "private_key": { - "description": "The Databricks secret key reference for a private key for the service\naccount which has access to the Google Cloud Vertex AI Service. See [Best\npractices for managing service account keys]. If you prefer to paste your\nAPI key directly, see `private_key_plaintext`. You must provide an API\nkey using one of the following fields: `private_key` or\n`private_key_plaintext`\n\n[Best practices for managing service account keys]: https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "private_key_plaintext": { - "description": "The private key for the service account which has access to the Google\nCloud Vertex AI Service provided as a plaintext secret. See [Best\npractices for managing service account keys]. If you prefer to reference\nyour key using Databricks Secrets, see `private_key`. You must provide an\nAPI key using one of the following fields: `private_key` or\n`private_key_plaintext`.\n\n[Best practices for managing service account keys]: https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "project_id": { - "description": "This is the Google Cloud project id that the service account is\nassociated with.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "region": { - "description": "This is the region for the Google Cloud Vertex AI Service. See [supported\nregions] for more details. Some models are only available in specific\nregions.\n\n[supported regions]: https://cloud.google.com/vertex-ai/docs/general/locations", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "project_id", - "region" - ] - }, - "serving.OpenAiConfig": { - "type": "object", - "description": "Configs needed to create an OpenAI model route.", - "properties": { - "microsoft_entra_client_id": { - "description": "This field is only required for Azure AD OpenAI and is the Microsoft\nEntra Client ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "microsoft_entra_client_secret": { - "description": "The Databricks secret key reference for a client secret used for\nMicrosoft Entra ID authentication. If you prefer to paste your client\nsecret directly, see `microsoft_entra_client_secret_plaintext`. You must\nprovide an API key using one of the following fields:\n`microsoft_entra_client_secret` or\n`microsoft_entra_client_secret_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "microsoft_entra_client_secret_plaintext": { - "description": "The client secret used for Microsoft Entra ID authentication provided as\na plaintext string. If you prefer to reference your key using Databricks\nSecrets, see `microsoft_entra_client_secret`. You must provide an API key\nusing one of the following fields: `microsoft_entra_client_secret` or\n`microsoft_entra_client_secret_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "microsoft_entra_tenant_id": { - "description": "This field is only required for Azure AD OpenAI and is the Microsoft\nEntra Tenant ID.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "openai_api_base": { - "description": "This is a field to provide a customized base URl for the OpenAI API. For\nAzure OpenAI, this field is required, and is the base URL for the Azure\nOpenAI API service provided by Azure. For other OpenAI API types, this\nfield is optional, and if left unspecified, the standard OpenAI base URL\nis used.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "openai_api_key": { - "description": "The Databricks secret key reference for an OpenAI API key using the\nOpenAI or Azure service. If you prefer to paste your API key directly,\nsee `openai_api_key_plaintext`. You must provide an API key using one of\nthe following fields: `openai_api_key` or `openai_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "openai_api_key_plaintext": { - "description": "The OpenAI API key using the OpenAI or Azure service provided as a\nplaintext string. If you prefer to reference your key using Databricks\nSecrets, see `openai_api_key`. You must provide an API key using one of\nthe following fields: `openai_api_key` or `openai_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "openai_api_type": { - "description": "This is an optional field to specify the type of OpenAI API to use. For\nAzure OpenAI, this field is required, and adjust this parameter to\nrepresent the preferred security access validation protocol. For access\ntoken validation, use azure. For authentication using Azure Active\nDirectory (Azure AD) use, azuread.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "openai_api_version": { - "description": "This is an optional field to specify the OpenAI API version. For Azure\nOpenAI, this field is required, and is the version of the Azure OpenAI\nservice to utilize, specified by a date.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "openai_deployment_name": { - "description": "This field is only required for Azure OpenAI and is the name of the\ndeployment resource for the Azure OpenAI service.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "openai_organization": { - "description": "This is an optional field to specify the organization in OpenAI or Azure\nOpenAI.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "serving.PaLmConfig": { - "type": "object", - "properties": { - "palm_api_key": { - "description": "The Databricks secret key reference for a PaLM API key. If you prefer to\npaste your API key directly, see `palm_api_key_plaintext`. You must\nprovide an API key using one of the following fields: `palm_api_key` or\n`palm_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "palm_api_key_plaintext": { - "description": "The PaLM API key provided as a plaintext string. If you prefer to\nreference your key using Databricks Secrets, see `palm_api_key`. You must\nprovide an API key using one of the following fields: `palm_api_key` or\n`palm_api_key_plaintext`.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "serving.RateLimit": { - "type": "object", - "properties": { - "calls": { - "description": "Used to specify how many calls are allowed for a key within the renewal_period.", - "$ref": "#/$defs/int64", - "x-since-version": "v0.229.0" - }, - "key": { - "description": "Key field for a serving endpoint rate limit. Currently, only 'user' and 'endpoint' are supported, with 'endpoint' being the default if not specified.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimitKey", - "x-since-version": "v0.229.0" - }, - "renewal_period": { - "description": "Renewal period field for a serving endpoint rate limit. Currently, only 'minute' is supported.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimitRenewalPeriod", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "calls", - "renewal_period" - ] - }, - "serving.RateLimitKey": { - "type": "string", - "enum": [ - "user", - "endpoint" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]" - ] - }, - "serving.RateLimitRenewalPeriod": { - "type": "string", - "enum": [ - "minute" - ], - "enumDescriptions": [ - "[Public Preview]" - ] - }, - "serving.Route": { - "type": "object", - "properties": { - "served_entity_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "served_model_name": { - "description": "The name of the served model this route configures traffic for.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "traffic_percentage": { - "description": "The percentage of endpoint traffic to send to this route. It must be an integer between 0 and 100 inclusive.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "traffic_percentage" - ] - }, - "serving.ServedEntityInput": { - "type": "object", - "properties": { - "burst_scaling_enabled": { - "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.288.0" - }, - "entity_name": { - "description": "The name of the entity to be served. The entity may be a model in the Databricks Model Registry, a model in the Unity Catalog (UC), or a function of type FEATURE_SPEC in the UC. If it is a UC object, the full name of the object should be given in the form of **catalog_name.schema_name.model_name**.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "entity_version": { - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "environment_vars": { - "description": "An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and subject to change. Example entity environment variables that refer to Databricks secrets: `{\"OPENAI_API_KEY\": \"{{secrets/my_scope/my_key}}\", \"DATABRICKS_TOKEN\": \"{{secrets/my_scope2/my_key2}}\"}`", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "external_model": { - "description": "The external model to be served. NOTE: Only one of external_model and (entity_name, entity_version, workload_size, workload_type, and scale_to_zero_enabled) can be specified with the latter set being used for custom model serving for a Databricks registered model. For an existing endpoint with external_model, it cannot be updated to an endpoint without external_model. If the endpoint is created without external_model, users cannot update it to add external_model later. The task type of all external models within an endpoint must be the same.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ExternalModel", - "x-since-version": "v0.229.0" - }, - "instance_profile_arn": { - "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "max_provisioned_concurrency": { - "description": "The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified.", - "$ref": "#/$defs/int", - "x-since-version": "v0.256.0" - }, - "max_provisioned_throughput": { - "description": "The maximum tokens per second that the endpoint can scale up to.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "min_provisioned_concurrency": { - "description": "The minimum provisioned concurrency that the endpoint can scale down to. Do not use if workload_size is specified.", - "$ref": "#/$defs/int", - "x-since-version": "v0.256.0" - }, - "min_provisioned_throughput": { - "description": "The minimum tokens per second that the endpoint can scale down to.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "name": { - "description": "The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "provisioned_model_units": { - "description": "[Public Preview] The number of model units provisioned.", - "$ref": "#/$defs/int64", - "x-since-version": "v0.252.0" - }, - "scale_to_zero_enabled": { - "description": "Whether the compute resources for the served entity should scale down to zero.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "workload_size": { - "description": "The workload size of the served entity. The workload size corresponds to a range of provisioned concurrency that the compute autoscales between. A single unit of provisioned concurrency can process one request at a time. Valid workload sizes are \"Small\" (4 - 4 provisioned concurrency), \"Medium\" (8 - 16 provisioned concurrency), and \"Large\" (16 - 64 provisioned concurrency). Additional custom workload sizes can also be used when available in the workspace. If scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size is 0. Do not use if min_provisioned_concurrency and max_provisioned_concurrency are specified.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "workload_type": { - "description": "The workload type of the served entity. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is \"CPU\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others. See the available [GPU types](https://docs.databricks.com/en/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServingModelWorkloadType", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "serving.ServedModelInput": { - "type": "object", - "properties": { - "burst_scaling_enabled": { - "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.288.0" - }, - "environment_vars": { - "description": "An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and subject to change. Example entity environment variables that refer to Databricks secrets: `{\"OPENAI_API_KEY\": \"{{secrets/my_scope/my_key}}\", \"DATABRICKS_TOKEN\": \"{{secrets/my_scope2/my_key2}}\"}`", - "$ref": "#/$defs/map/string", - "x-since-version": "v0.229.0" - }, - "instance_profile_arn": { - "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "max_provisioned_concurrency": { - "description": "The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified.", - "$ref": "#/$defs/int", - "x-since-version": "v0.256.0" - }, - "max_provisioned_throughput": { - "description": "The maximum tokens per second that the endpoint can scale up to.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "min_provisioned_concurrency": { - "description": "The minimum provisioned concurrency that the endpoint can scale down to. Do not use if workload_size is specified.", - "$ref": "#/$defs/int", - "x-since-version": "v0.256.0" - }, - "min_provisioned_throughput": { - "description": "The minimum tokens per second that the endpoint can scale down to.", - "$ref": "#/$defs/int", - "x-since-version": "v0.229.0" - }, - "model_name": { - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "model_version": { - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "name": { - "description": "The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to entity_name-entity_version.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "provisioned_model_units": { - "description": "[Public Preview] The number of model units provisioned.", - "$ref": "#/$defs/int64", - "x-since-version": "v0.252.0" - }, - "scale_to_zero_enabled": { - "description": "Whether the compute resources for the served entity should scale down to zero.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" - }, - "workload_size": { - "description": "The workload size of the served entity. The workload size corresponds to a range of provisioned concurrency that the compute autoscales between. A single unit of provisioned concurrency can process one request at a time. Valid workload sizes are \"Small\" (4 - 4 provisioned concurrency), \"Medium\" (8 - 16 provisioned concurrency), and \"Large\" (16 - 64 provisioned concurrency). Additional custom workload sizes can also be used when available in the workspace. If scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size is 0. Do not use if min_provisioned_concurrency and max_provisioned_concurrency are specified.", - "$ref": "#/$defs/string", - "x-since-version": "v0.229.0" - }, - "workload_type": { - "description": "The workload type of the served entity. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is \"CPU\". For deep learning workloads, GPU acceleration is available by selecting workload types like GPU_SMALL and others. See the available [GPU types](https://docs.databricks.com/en/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInputWorkloadType", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false, - "required": [ - "model_name", - "model_version", - "scale_to_zero_enabled" - ] - }, - "serving.ServedModelInputWorkloadType": { - "type": "string", - "description": "Please keep this in sync with workload types in InferenceEndpointEntities.scala.", - "enum": [ - "CPU", - "GPU_MEDIUM", - "GPU_SMALL", - "GPU_LARGE", - "MULTIGPU_MEDIUM", - "GPU_XLARGE" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "[Beta]" - ] - }, - "serving.ServingEndpointPermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "CAN_QUERY", - "CAN_VIEW" - ] - }, - "serving.ServingModelWorkloadType": { - "type": "string", - "description": "Please keep this in sync with workload types in InferenceEndpointEntities.scala.", - "enum": [ - "CPU", - "GPU_MEDIUM", - "GPU_SMALL", - "GPU_LARGE", - "MULTIGPU_MEDIUM", - "GPU_XLARGE" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "[Beta]" - ] - }, - "serving.TrafficConfig": { - "type": "object", - "properties": { - "routes": { - "description": "The list of routes that define traffic to each served entity.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.Route", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "sql.Aggregation": { - "type": "string", - "enum": [ - "SUM", - "COUNT", - "COUNT_DISTINCT", - "AVG", - "MEDIAN", - "MIN", - "MAX", - "STDDEV" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "sql.AlertEvaluationState": { - "type": "string", - "description": "UNSPECIFIED - default unspecify value for proto enum, do not use it in the code\nUNKNOWN - alert not yet evaluated\nTRIGGERED - alert is triggered\nOK - alert is not triggered\nERROR - alert evaluation failed", - "enum": [ - "UNKNOWN", - "TRIGGERED", - "OK", - "ERROR" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "sql.AlertLifecycleState": { - "type": "string", - "enum": [ - "ACTIVE", - "DELETED" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]" - ] - }, - "sql.AlertV2Evaluation": { - "type": "object", - "properties": { - "comparison_operator": { - "description": "[Public Preview] Operator used for comparison in alert evaluation.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator", - "x-since-version": "v0.279.0" - }, - "empty_result_state": { - "description": "[Public Preview] Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState", - "x-since-version": "v0.279.0" - }, - "notification": { - "description": "[Public Preview] User or Notification Destination to notify when alert is triggered.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Notification", - "x-since-version": "v0.279.0" - }, - "source": { - "description": "[Public Preview] Source column from result to use to evaluate alert", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", - "x-since-version": "v0.279.0" - }, - "threshold": { - "description": "[Public Preview] Threshold to user for alert evaluation, can be a column or a value.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Operand", - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false, - "required": [ - "comparison_operator", - "source" - ] - }, - "sql.AlertV2Notification": { - "type": "object", - "properties": { - "notify_on_ok": { - "description": "[Public Preview] Whether to notify alert subscribers when alert returns back to normal.", - "$ref": "#/$defs/bool", - "x-since-version": "v0.279.0" - }, - "retrigger_seconds": { - "description": "[Public Preview] Number of seconds an alert waits after being triggered before it is allowed to send another notification.\nIf set to 0 or omitted, the alert will not send any further notifications after the first trigger\nSetting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes.", - "$ref": "#/$defs/int", - "x-since-version": "v0.279.0" - }, - "subscriptions": { - "description": "[Public Preview]", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription", - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false - }, - "sql.AlertV2Operand": { - "type": "object", - "properties": { - "column": { - "description": "[Public Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", - "x-since-version": "v0.279.0" - }, - "value": { - "description": "[Public Preview]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue", - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false - }, - "sql.AlertV2OperandColumn": { - "type": "object", - "properties": { - "aggregation": { - "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" - }, - "display": { - "description": "[Public Preview]", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - }, - "name": { - "description": "[Public Preview]", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false, - "required": [ - "name" - ] - }, - "sql.AlertV2OperandValue": { - "type": "object", - "properties": { - "bool_value": { - "description": "[Public Preview]", - "$ref": "#/$defs/bool", - "x-since-version": "v0.279.0" - }, - "double_value": { - "description": "[Public Preview]", - "$ref": "#/$defs/float64", - "x-since-version": "v0.279.0" - }, - "string_value": { - "description": "[Public Preview]", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false - }, - "sql.AlertV2RunAs": { - "type": "object", - "properties": { - "service_principal_name": { - "description": "[Public Preview] Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - }, - "user_name": { - "description": "[Public Preview] The email of an active workspace user. Can only set this field to their own email.", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false - }, - "sql.AlertV2Subscription": { - "type": "object", - "properties": { - "destination_id": { - "description": "[Public Preview]", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - }, - "user_email": { - "description": "[Public Preview]", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false - }, - "sql.Channel": { - "type": "object", - "description": "Configures the channel name and DBSQL version of the warehouse. CHANNEL_NAME_CUSTOM should be chosen only when `dbsql_version` is specified.", - "properties": { - "dbsql_version": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "name": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ChannelName", - "x-since-version": "v0.260.0" - } - }, - "additionalProperties": false - }, - "sql.ChannelName": { - "type": "string", - "enum": [ - "CHANNEL_NAME_PREVIEW", - "CHANNEL_NAME_CURRENT", - "CHANNEL_NAME_PREVIOUS", - "CHANNEL_NAME_CUSTOM" - ] - }, - "sql.ComparisonOperator": { - "type": "string", - "enum": [ - "LESS_THAN", - "GREATER_THAN", - "EQUAL", - "NOT_EQUAL", - "GREATER_THAN_OR_EQUAL", - "LESS_THAN_OR_EQUAL", - "IS_NULL", - "IS_NOT_NULL" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" - ] - }, - "sql.CreateWarehouseRequestWarehouseType": { - "type": "string", - "enum": [ - "TYPE_UNSPECIFIED", - "CLASSIC", - "PRO" - ] - }, - "sql.CronSchedule": { - "type": "object", - "properties": { - "pause_status": { - "description": "[Public Preview] Indicate whether this schedule is paused or not.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus", - "x-since-version": "v0.279.0" - }, - "quartz_cron_schedule": { - "description": "[Public Preview] A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - }, - "timezone_id": { - "description": "[Public Preview] A Java timezone id. The schedule will be resolved using this timezone.\nThis will be combined with the quartz_cron_schedule to determine the schedule.\nSee https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.", - "$ref": "#/$defs/string", - "x-since-version": "v0.279.0" - } - }, - "additionalProperties": false, - "required": [ - "quartz_cron_schedule", - "timezone_id" - ] - }, - "sql.EndpointTagPair": { - "type": "object", - "properties": { - "key": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - }, - "value": { - "$ref": "#/$defs/string", - "x-since-version": "v0.260.0" - } - }, - "additionalProperties": false - }, - "sql.EndpointTags": { - "type": "object", - "properties": { - "custom_tags": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.EndpointTagPair", - "x-since-version": "v0.260.0" - } - }, - "additionalProperties": false - }, - "sql.SchedulePauseStatus": { - "type": "string", - "enum": [ - "UNPAUSED", - "PAUSED" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]" - ] - }, - "sql.SpotInstancePolicy": { - "type": "string", - "description": "EndpointSpotInstancePolicy configures whether the endpoint should use spot\ninstances.\n\nThe breakdown of how the EndpointSpotInstancePolicy converts to per cloud\nconfigurations is:\n\n+-------+--------------------------------------+--------------------------------+\n| Cloud | COST_OPTIMIZED | RELIABILITY_OPTIMIZED |\n+-------+--------------------------------------+--------------------------------+\n| AWS | On Demand Driver with Spot Executors | On Demand Driver and\nExecutors | | AZURE | On Demand Driver and Executors | On Demand Driver\nand Executors |\n+-------+--------------------------------------+--------------------------------+", - "enum": [ - "POLICY_UNSPECIFIED", - "COST_OPTIMIZED", - "RELIABILITY_OPTIMIZED" - ] - }, - "sql.WarehousePermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "IS_OWNER", - "CAN_USE", - "CAN_MONITOR", - "CAN_VIEW" - ] - }, - "vectorsearch.DeltaSyncVectorIndexSpecRequest": { - "type": "object", - "properties": { - "columns_to_index": { - "description": "[Optional] Alias for columns_to_sync. Select the columns to include in the vector index.\nIf you leave this field blank, all columns from the source table are included.\nThe primary key column and embedding source column or embedding vector column are always included.\nOnly one of columns_to_sync or columns_to_index may be specified.", - "$ref": "#/$defs/slice/string", - "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" - } - }, - "additionalProperties": false - }, - "vectorsearch.DirectAccessVectorIndexSpec": { - "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" - } - }, - "additionalProperties": false - }, - "vectorsearch.EmbeddingSourceColumn": { - "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" - } - }, - "additionalProperties": false - }, - "vectorsearch.EmbeddingVectorColumn": { - "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" - } - }, - "additionalProperties": false - }, - "vectorsearch.EndpointType": { - "type": "string", - "description": "Type of endpoint.", - "enum": [ - "STORAGE_OPTIMIZED", - "STANDARD" - ] - }, - "vectorsearch.IndexSubtype": { - "type": "string", - "description": "The subtype of the AI Search index, determining the indexing and retrieval strategy.\n- `VECTOR`: Not supported. Use `HYBRID` instead.\n- `FULL_TEXT`: An index that uses full-text search without vector embeddings.\n- `HYBRID`: An index that uses vector embeddings for similarity search and hybrid search.", - "enum": [ - "VECTOR", - "FULL_TEXT", - "HYBRID" - ], - "enumDescriptions": [ - "[Beta] Not supported. Use `HYBRID` instead.", - "[Beta] An index that uses full-text search without vector embeddings.", - "[Beta] An index that uses vector embeddings for similarity search and hybrid search." - ] - }, - "vectorsearch.PipelineType": { - "type": "string", - "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.", - "enum": [ - "TRIGGERED", - "CONTINUOUS" - ], - "enumDescriptions": [ - "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.", - "If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh." - ] - }, - "vectorsearch.VectorIndexType": { - "type": "string", - "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.", - "enum": [ - "DELTA_SYNC", - "DIRECT_ACCESS" - ], - "enumDescriptions": [ - "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.", - "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." - ] - }, - "workspace.AzureKeyVaultSecretScopeMetadata": { - "type": "object", - "description": "The metadata of the Azure KeyVault for a secret scope of type `AZURE_KEYVAULT`", - "properties": { - "dns_name": { - "description": "The DNS of the KeyVault", - "$ref": "#/$defs/string", - "x-since-version": "v0.252.0" - }, - "resource_id": { - "description": "The resource id of the azure KeyVault that user wants to associate the scope with.", - "$ref": "#/$defs/string", - "x-since-version": "v0.252.0" - } - }, - "additionalProperties": false, - "required": [ - "dns_name", - "resource_id" - ] - }, - "workspace.ScopeBackendType": { - "type": "string", - "description": "The types of secret scope backends in the Secret Manager. Azure KeyVault backed secret scopes\nwill be supported in a later release.", - "enum": [ - "DATABRICKS", - "AZURE_KEYVAULT" - ] - } - } - } - } - }, - "int": { - "type": "integer" - }, - "int64": { - "type": "integer" - }, - "interface": {}, - "map": { - "github.com": { - "databricks": { - "cli": { - "bundle": { - "config": { - "resources.Alert": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Alert" - } - }, - "resources.App": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.App" - } - }, - "resources.Catalog": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Catalog" - } - }, - "resources.Cluster": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Cluster" - } - }, - "resources.Dashboard": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Dashboard" - } - }, - "resources.DatabaseCatalog": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.DatabaseCatalog" - } - }, - "resources.DatabaseInstance": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.DatabaseInstance" - } - }, - "resources.ExternalLocation": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ExternalLocation" - } - }, - "resources.GenieSpace": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.GenieSpace" - } - }, - "resources.Job": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Job" - } - }, - "resources.MlflowExperiment": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.MlflowExperiment" - } - }, - "resources.MlflowModel": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.MlflowModel" - } - }, - "resources.ModelServingEndpoint": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ModelServingEndpoint" - } - }, - "resources.Pipeline": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Pipeline" - } - }, - "resources.PostgresBranch": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresBranch" - } - }, - "resources.PostgresCatalog": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresCatalog" - } - }, - "resources.PostgresDatabase": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresDatabase" - } - }, - "resources.PostgresEndpoint": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresEndpoint" - } - }, - "resources.PostgresProject": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresProject" - } - }, - "resources.PostgresRole": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresRole" - } - }, - "resources.PostgresSyncedTable": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresSyncedTable" - } - }, - "resources.QualityMonitor": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.QualityMonitor" - } - }, - "resources.RegisteredModel": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.RegisteredModel" - } - }, - "resources.Schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Schema" - } - }, - "resources.SecretScope": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.SecretScope" - } - }, - "resources.SqlWarehouse": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.SqlWarehouse" - } - }, - "resources.SyncedDatabaseTable": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable" - } - }, - "resources.VectorSearchEndpoint": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.VectorSearchEndpoint" - } - }, - "resources.VectorSearchIndex": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.VectorSearchIndex" - } - }, - "resources.Volume": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Volume" - } - }, - "variable.TargetVariable": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.TargetVariable" - } - }, - "variable.Variable": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.Variable" - } - } - }, - "config.Artifact": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Artifact" - } - }, - "config.Command": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Command" - } - }, - "config.Script": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Script" - } - }, - "config.Target": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Target" - } - } - } - } - } - }, - "string": { - "type": "object", - "additionalProperties": { - "$ref": "#/$defs/string" - } - } - }, - "slice": { - "github.com": { - "databricks": { - "cli": { - "bundle": { - "config": { - "resources.AppEnvVar": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.AppEnvVar" - } - }, - "resources.AppPermission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.AppPermission" - } - }, - "resources.ClusterPermission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ClusterPermission" - } - }, - "resources.JobPermission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.JobPermission" - } - }, - "resources.MlflowExperimentPermission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.MlflowExperimentPermission" - } - }, - "resources.MlflowModelPermission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.MlflowModelPermission" - } - }, - "resources.ModelServingEndpointPermission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ModelServingEndpointPermission" - } - }, - "resources.Permission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Permission" - } - }, - "resources.PipelinePermission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PipelinePermission" - } - }, - "resources.SecretScopePermission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.SecretScopePermission" - } - }, - "resources.SqlWarehousePermission": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.SqlWarehousePermission" - } - } - }, - "config.ArtifactFile": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.ArtifactFile" - } - } - } - }, - "databricks-sdk-go": { - "service": { - "apps.AppResource": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResource" - } - }, - "apps.EnvVar": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.EnvVar" - } - }, - "apps.TelemetryExportDestination": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination" - } - }, - "catalog.MonitorMetric": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetric" - } - }, - "catalog.Privilege": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.Privilege" - } - }, - "catalog.PrivilegeAssignment": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" - } - }, - "catalog.RegisteredModelAlias": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.RegisteredModelAlias" - } - }, - "compute.InitScriptInfo": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo" - } - }, - "compute.Library": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Library" - } - }, - "database.CustomTag": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.CustomTag" - } - }, - "database.DatabaseInstanceRef": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef" - } - }, - "database.SyncedTableSpecTypeOverride": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpecTypeOverride" - } - }, - "jobs.AlertTaskSubscriber": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber" - } - }, - "jobs.JobCluster": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobCluster" - } - }, - "jobs.JobEnvironment": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironment" - } - }, - "jobs.JobParameterDefinition": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobParameterDefinition" - } - }, - "jobs.JobsHealthRule": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRule" - } - }, - "jobs.PowerBiTable": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable" - } - }, - "jobs.PythonOperatorTaskParameter": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter" - } - }, - "jobs.SqlTaskSubscription": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription" - } - }, - "jobs.SubscriptionSubscriber": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionSubscriber" - } - }, - "jobs.Task": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Task" - } - }, - "jobs.TaskDependency": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskDependency" - } - }, - "jobs.Webhook": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Webhook" - } - }, - "ml.ExperimentTag": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTag" - } - }, - "ml.ModelTag": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ModelTag" - } - }, - "pipelines.DayOfWeek": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek" - } - }, - "pipelines.FileFilter": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter" - } - }, - "pipelines.IngestionConfig": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig" - } - }, - "pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue" - } - }, - "pipelines.Notifications": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications" - } - }, - "pipelines.PipelineCluster": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster" - } - }, - "pipelines.PipelineLibrary": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary" - } - }, - "pipelines.SourceConfig": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig" - } - }, - "postgres.ProjectCustomTag": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.ProjectCustomTag" - } - }, - "postgres.RoleMembershipRole": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleMembershipRole" - } - }, - "postgres.SyncedTableSyncedTableSpecTypeOverride": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecTypeOverride" - } - }, - "serving.AiGatewayRateLimit": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimit" - } - }, - "serving.EndpointTag": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EndpointTag" - } - }, - "serving.RateLimit": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimit" - } - }, - "serving.Route": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.Route" - } - }, - "serving.ServedEntityInput": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput" - } - }, - "serving.ServedModelInput": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput" - } - }, - "sql.AlertV2Subscription": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription" - } - }, - "sql.EndpointTagPair": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.EndpointTagPair" - } - }, - "vectorsearch.EmbeddingSourceColumn": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn" - } - }, - "vectorsearch.EmbeddingVectorColumn": { - "type": "array", - "items": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn" - } - } - } - } - } - }, - "string": { - "type": "array", - "items": { - "$ref": "#/$defs/string" - } - } - }, - "string": { - "type": "string" - } - }, - "type": "object", - "properties": { - "artifacts": { - "description": "Defines the attributes to build an artifact", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Artifact", - "markdownDescription": "Defines the attributes to build artifacts, where each key is the name of the artifact, and the value is a Map that defines the artifact build settings. For information about the `artifacts` mapping, see [artifacts](https://docs.databricks.com/dev-tools/bundles/settings.html#artifacts).\n\nArtifact settings defined in the top level of the bundle configuration can be overridden in the `targets` mapping. See [link](https://docs.databricks.com/dev-tools/bundles/artifact-overrides.html).", - "x-since-version": "v0.229.0" - }, - "bundle": { - "description": "The bundle attributes when deploying to this target.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Bundle", - "markdownDescription": "The bundle attributes when deploying to this target,", - "x-since-version": "v0.229.0" - }, - "environments": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Target", - "deprecationMessage": "Deprecated: please use targets instead", - "x-since-version": "v0.243.0", - "deprecated": true - }, - "experimental": { - "description": "Defines attributes for experimental features.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Experimental", - "x-since-version": "v0.229.0" - }, - "include": { - "description": "Specifies a list of path globs that contain configuration files to include within the bundle.", - "$ref": "#/$defs/slice/string", - "markdownDescription": "Specifies a list of path globs that contain configuration files to include within the bundle. See [include](https://docs.databricks.com/dev-tools/bundles/settings.html#include).", - "x-since-version": "v0.229.0" - }, - "permissions": { - "description": "Defines a permission for a specific entity.", - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", - "markdownDescription": "A Sequence that defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle, where each item in the sequence is a permission for a specific entity.\n\nSee [permissions](https://docs.databricks.com/dev-tools/bundles/settings.html#permissions) and [link](https://docs.databricks.com/dev-tools/bundles/permissions.html).", - "x-since-version": "v0.229.0" - }, - "presets": { - "description": "Defines bundle deployment presets.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Presets", - "markdownDescription": "Defines bundle deployment presets. See [presets](https://docs.databricks.com/dev-tools/bundles/deployment-modes.html#presets).", - "x-since-version": "v0.229.0" - }, - "python": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Python", - "x-since-version": "v0.275.0" - }, - "resources": { - "description": "A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Resources", - "markdownDescription": "A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource. For more information about Declarative Automation Bundles supported resources, and resource definition reference, see [link](https://docs.databricks.com/dev-tools/bundles/resources.html).\n\n```yaml\nresources:\n \u003cresource-type\u003e:\n \u003cresource-name\u003e:\n \u003cresource-field-name\u003e: \u003cresource-field-value\u003e\n```", - "x-since-version": "v0.229.0" - }, - "run_as": { - "description": "The identity to use when running Declarative Automation Bundles resources.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs", - "markdownDescription": "The identity to use when running Declarative Automation Bundles resources. See [link](https://docs.databricks.com/dev-tools/bundles/run-as.html).", - "x-since-version": "v0.229.0" - }, - "scripts": { - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Script", - "x-since-version": "v0.259.0" - }, - "sync": { - "description": "The files and file paths to include or exclude in the bundle.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Sync", - "markdownDescription": "The files and file paths to include or exclude in the bundle. See [sync](https://docs.databricks.com/dev-tools/bundles/settings.html#sync).", - "x-since-version": "v0.229.0" - }, - "targets": { - "description": "Defines deployment targets for the bundle.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config.Target", - "markdownDescription": "Defines deployment targets for the bundle. See [targets](https://docs.databricks.com/dev-tools/bundles/settings.html#targets)", - "x-since-version": "v0.229.0" - }, - "variables": { - "description": "A Map that defines the custom variables for the bundle, where each key is the name of the variable, and the value is a Map that defines the variable.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/variable.Variable", - "x-since-version": "v0.229.0" - }, - "workspace": { - "description": "Defines the Databricks workspace for the bundle.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Workspace", - "markdownDescription": "Defines the Databricks workspace for the bundle. See [workspace](https://docs.databricks.com/dev-tools/bundles/settings.html#workspace).", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": {} -} \ No newline at end of file