From 1249e89123fe46baa7e706cf1a06aac3df846677 Mon Sep 17 00:00:00 2001 From: Shreyas Goenka Date: Wed, 6 May 2026 21:13:32 +0200 Subject: [PATCH 01/31] Bootstrap docgen branch (will be populated by update-schema-docs workflow) From 08d6a67aea51c47d490671d59b4ff6fd1a1032a3 Mon Sep 17 00:00:00 2001 From: Shreyas Goenka Date: Wed, 6 May 2026 21:13:58 +0200 Subject: [PATCH 02/31] Bootstrap docgen branch --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000000..3dd8194f2ef --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# docgen + +This branch is the publish target for `bundle/schema/jsonschema_for_docs.json`. + +It is updated automatically by the `update-schema-docs` workflow on every `v*` +release tag push: the workflow regenerates the schema (so newly-released fields +get their `x-since-version` annotation) and commits the result here. + +Do not edit this branch by hand. From 2ca6aaf0c330f95fd2bedbc2ef12657c06ca1fb6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 6 May 2026 19:19:35 +0000 Subject: [PATCH 03/31] Update jsonschema_for_docs.json for refs/heads/workflow/update-schema-docs-on-release --- bundle/schema/jsonschema_for_docs.json | 9965 ++++++++++++++++++++++++ 1 file changed, 9965 insertions(+) create mode 100644 bundle/schema/jsonschema_for_docs.json diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json new file mode 100644 index 00000000000..dd36c9aef60 --- /dev/null +++ b/bundle/schema/jsonschema_for_docs.json @@ -0,0 +1,9965 @@ +{ + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.279.0" + }, + "custom_summary": { + "$ref": "#/$defs/string", + "x-since-version": "v0.279.0" + }, + "display_name": { + "$ref": "#/$defs/string", + "x-since-version": "v0.279.0" + }, + "evaluation": { + "$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": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.279.0" + }, + "run_as": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs", + "x-since-version": "v0.279.0" + }, + "run_as_user_name": { + "$ref": "#/$defs/string", + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.279.0", + "deprecated": true + }, + "schedule": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule", + "x-since-version": "v0.279.0" + }, + "warehouse_id": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.243.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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "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": "Name of the space this app belongs to.", + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.290.0" + }, + "telemetry_export_destinations": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination", + "x-since-version": "v0.294.0" + }, + "usage_policy_id": { + "$ref": "#/$defs/string", + "x-since-version": "v0.283.0" + }, + "user_api_scopes": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.287.0" + }, + "connection_name": { + "$ref": "#/$defs/string", + "x-since-version": "v0.287.0" + }, + "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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.298.0" + }, + "name": { + "$ref": "#/$defs/string", + "x-since-version": "v0.287.0" + }, + "options": { + "$ref": "#/$defs/map/string", + "x-since-version": "v0.287.0" + }, + "properties": { + "$ref": "#/$defs/map/string", + "x-since-version": "v0.287.0" + }, + "provider_name": { + "$ref": "#/$defs/string", + "x-since-version": "v0.287.0" + }, + "share_name": { + "$ref": "#/$defs/string", + "x-since-version": "v0.287.0" + }, + "storage_root": { + "$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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", + "x-since-version": "v0.229.0" + }, + "docker_image": { + "$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": { + "$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.Lifecycle", + "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": { + "$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": { + "$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": { + "$ref": "#/$defs/bool", + "x-since-version": "v0.265.0" + }, + "database_instance_name": { + "description": "The name of the DatabaseInstance housing the database.", + "$ref": "#/$defs/string", + "x-since-version": "v0.265.0" + }, + "database_name": { + "description": "The name of the database (in a 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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": "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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.289.0" + }, + "credential_name": { + "$ref": "#/$defs/string", + "x-since-version": "v0.289.0" + }, + "enable_file_events": { + "$ref": "#/$defs/bool", + "x-since-version": "v0.289.0" + }, + "encryption_details": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionDetails", + "x-since-version": "v0.289.0" + }, + "fallback": { + "$ref": "#/$defs/bool", + "x-since-version": "v0.289.0" + }, + "file_event_queue": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.289.0" + }, + "read_only": { + "$ref": "#/$defs/bool", + "x-since-version": "v0.289.0" + }, + "skip_validation": { + "$ref": "#/$defs/bool", + "x-since-version": "v0.289.0" + }, + "url": { + "$ref": "#/$defs/string", + "x-since-version": "v0.289.0" + } + }, + "additionalProperties": false, + "required": [ + "credential_name", + "name", + "url" + ] + }, + "resources.Job": { + "type": "object", + "properties": { + "budget_policy_id": { + "description": "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": { + "$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": { + "$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": "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-preview": "PRIVATE", + "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": "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": "DLT 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": "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": "The definition of a gateway pipeline to support change data capture.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition", + "x-databricks-preview": "PRIVATE", + "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": "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" + }, + "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": "Restart window of this pipeline.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.234.0" + }, + "root_path": { + "description": "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": { + "$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" + }, + "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": "Usage policy of this pipeline.", + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "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" + }, + "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.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" + }, + "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" + } + }, + "additionalProperties": false, + "required": [ + "project_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": "[Create:OPT Update:OPT] Data classification related config.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificationConfig", + "x-databricks-preview": "PRIVATE", + "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": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RegisteredModelAlias", + "x-since-version": "v0.273.0" + }, + "browse_only": { + "$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": { + "$ref": "#/$defs/int64", + "x-since-version": "v0.273.0" + }, + "created_by": { + "$ref": "#/$defs/string", + "x-since-version": "v0.273.0" + }, + "full_name": { + "$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": { + "$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": { + "$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": { + "$ref": "#/$defs/int64", + "x-since-version": "v0.273.0" + }, + "updated_by": { + "$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" + }, + "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": { + "$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", + "$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.Lifecycle", + "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": { + "$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": { + "$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": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.266.0" + }, + "name": { + "$ref": "#/$defs/string", + "x-since-version": "v0.266.0" + }, + "spec": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.298.0" + }, + "endpoint_type": { + "$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" + }, + "min_qps": { + "$ref": "#/$defs/int64", + "x-since-version": "v0.298.0" + }, + "name": { + "$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" + }, + "usage_policy_id": { + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.298.0" + } + }, + "additionalProperties": false, + "required": [ + "endpoint_type", + "name" + ] + }, + "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": { + "$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" + }, + "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" + }, + "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_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" + }, + "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" + }, + "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": { + "$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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.283.0" + }, + "mode": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentMode", + "x-since-version": "v0.239.0" + }, + "source_code_path": { + "$ref": "#/$defs/string", + "x-since-version": "v0.239.0" + } + }, + "additionalProperties": false + }, + "apps.AppDeploymentArtifacts": { + "type": "object", + "properties": { + "source_code_path": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.239.0" + }, + "permission": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.239.0" + }, + "permission": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecretSecretPermission", + "x-since-version": "v0.239.0" + }, + "scope": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.239.0" + }, + "permission": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.239.0" + }, + "permission": { + "$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": "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": "Unity Catalog table for OTEL logs.", + "$ref": "#/$defs/string", + "x-since-version": "v0.294.0" + }, + "metrics_table": { + "description": "Unity Catalog table for OTEL metrics.", + "$ref": "#/$defs/string", + "x-since-version": "v0.294.0" + }, + "traces_table": { + "description": "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": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.289.0" + }, + "resource_group": { + "$ref": "#/$defs/string", + "x-since-version": "v0.289.0" + }, + "subscription_id": { + "$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": { + "$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": { + "$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": "Whether to enable data classification.", + "$ref": "#/$defs/bool", + "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": "Destinations to send notifications on new classification tag detected.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", + "x-databricks-preview": "PRIVATE", + "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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.273.0" + }, + "id": { + "$ref": "#/$defs/string", + "x-since-version": "v0.273.0" + }, + "model_name": { + "$ref": "#/$defs/string", + "x-since-version": "v0.273.0" + }, + "schema_name": { + "$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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.SseEncryptionDetailsAlgorithm", + "x-since-version": "v0.289.0" + }, + "aws_kms_key_arn": { + "$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": { + "$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": { + "$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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAvailability", + "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.\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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", + "x-since-version": "v0.229.0" + }, + "docker_image": { + "$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": { + "$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": { + "$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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType", + "x-since-version": "v0.229.0" + } + }, + "additionalProperties": false + }, + "compute.DataSecurityMode": { + "type": "string", + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\nThe following modes can only be used when `kind = CLASSIC_PREVIEW`.\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\n\nThe following modes can be used regardless of `kind`.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n* `SINGLE_USER`: 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* `USER_ISOLATION`: 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\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" + ] + }, + "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": { + "$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 DLT'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. For 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": { + "$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": { + "$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" + }, + "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" + ] + }, + "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", + "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": "The key of the custom tag.", + "$ref": "#/$defs/string", + "x-since-version": "v0.273.0" + }, + "value": { + "description": "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": "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": "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": "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" + ] + }, + "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": "Budget policy to set on the newly created pipeline.", + "$ref": "#/$defs/string", + "x-since-version": "v0.279.0" + }, + "storage_catalog": { + "description": "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": "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" + ] + }, + "database.ProvisioningPhase": { + "type": "string", + "enum": [ + "PROVISIONING_PHASE_MAIN", + "PROVISIONING_PHASE_INDEX_SCAN", + "PROVISIONING_PHASE_INDEX_SORT" + ] + }, + "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" + ] + }, + "database.SyncedTableSpec": { + "type": "object", + "description": "Specification of a synced database table.", + "properties": { + "create_database_objects_if_missing": { + "description": "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": "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": "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": "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": "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": "Three-part (catalog, schema, table) name of the source Delta table.", + "$ref": "#/$defs/string", + "x-since-version": "v0.266.0" + }, + "timeseries_key": { + "description": "Time series key to deduplicate (tie-break) rows with the same primary key.", + "$ref": "#/$defs/string", + "x-since-version": "v0.266.0" + } + }, + "additionalProperties": false + }, + "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" + ] + }, + "database.SyncedTableStatus": { + "type": "object", + "description": "Status of a synced table.", + "properties": { + "continuous_update_status": { + "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.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus", + "x-since-version": "v0.266.0" + }, + "failed_status": { + "description": "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": "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": "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" + ] + }, + "jobs.AlertTask": { + "type": "object", + "properties": { + "alert_id": { + "description": "The alert_id is the canonical identifier of the alert.", + "$ref": "#/$defs/string", + "x-since-version": "v0.296.0" + }, + "subscribers": { + "description": "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": "The warehouse_id identifies the warehouse settings used by the alert task.", + "$ref": "#/$defs/string", + "x-since-version": "v0.296.0" + }, + "workspace_path": { + "description": "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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.296.0" + }, + "user_name": { + "description": "A valid workspace email address.", + "$ref": "#/$defs/string", + "x-since-version": "v0.296.0" + } + }, + "additionalProperties": false + }, + "jobs.AuthenticationMethod": { + "type": "string", + "enum": [ + "OAUTH", + "PAT" + ] + }, + "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": "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": "IDof the GPU pool to use.", + "$ref": "#/$defs/string", + "x-since-version": "v0.243.0" + }, + "gpu_type": { + "description": "GPU type.", + "$ref": "#/$defs/string", + "x-since-version": "v0.243.0" + }, + "num_gpus": { + "description": "Number of GPUs.", + "$ref": "#/$defs/int", + "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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.248.0" + }, + "filters": { + "description": "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-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.289.0" + }, + "subscription": { + "$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": "The resource name of the UC connection that authenticates the dbt Cloud for this task", + "$ref": "#/$defs/string", + "x-since-version": "v0.256.0" + }, + "dbt_cloud_job_id": { + "description": "Id of the dbt Cloud job to be triggered", + "$ref": "#/$defs/int64", + "x-since-version": "v0.256.0" + } + }, + "additionalProperties": false + }, + "jobs.DbtPlatformTask": { + "type": "object", + "properties": { + "connection_resource_name": { + "description": "The resource name of the UC connection that authenticates the dbt platform for this task", + "$ref": "#/$defs/string", + "x-since-version": "v0.257.0" + }, + "dbt_platform_job_id": { + "description": "Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", + "$ref": "#/$defs/string", + "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", + "properties": { + "command": { + "description": "Command launcher to run the actual script, e.g. bash, python etc.", + "$ref": "#/$defs/string", + "x-since-version": "v0.243.0" + }, + "compute": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", + "x-since-version": "v0.243.0" + }, + "dl_runtime_image": { + "description": "Runtime image", + "$ref": "#/$defs/string", + "x-since-version": "v0.243.0" + }, + "mlflow_experiment_name": { + "description": "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-since-version": "v0.243.0" + }, + "source": { + "description": "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-since-version": "v0.243.0" + }, + "training_script_path": { + "description": "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-since-version": "v0.243.0" + }, + "yaml_parameters": { + "description": "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-since-version": "v0.243.0" + }, + "yaml_parameters_file_path": { + "description": "Optional path to a YAML file containing model parameters passed to the training script.", + "$ref": "#/$defs/string", + "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" + ] + }, + "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" + ] + }, + "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": "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": { + "$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": "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-preview": "PRIVATE", + "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": "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-since-version": "v0.229.0" + }, + "import_from_git_branch": { + "description": "Name of the branch which the job is imported from.", + "$ref": "#/$defs/string", + "x-since-version": "v0.229.0" + }, + "job_config_path": { + "description": "Path of the job YAML file that contains the job specification.", + "$ref": "#/$defs/string", + "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" + ] + }, + "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" + ] + }, + "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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric", + "x-since-version": "v0.229.0" + }, + "op": { + "$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": "Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v0.279.0" + }, + "condition": { + "description": "The condition based on which to trigger a job run.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", + "x-since-version": "v0.279.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.279.0" + }, + "securable_name": { + "description": "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-since-version": "v0.279.0" + }, + "wait_after_last_change_seconds": { + "description": "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-since-version": "v0.279.0" + } + }, + "additionalProperties": false, + "required": [ + "condition" + ] + }, + "jobs.ModelTriggerConfigurationCondition": { + "type": "string", + "enum": [ + "MODEL_CREATED", + "MODEL_VERSION_READY", + "MODEL_ALIAS_SET" + ] + }, + "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 delta live table.", + "$ref": "#/$defs/bool", + "x-since-version": "v0.229.0" + } + }, + "additionalProperties": false + }, + "jobs.PipelineTask": { + "type": "object", + "properties": { + "full_refresh": { + "description": "If true, triggers a full refresh on the delta live table.", + "$ref": "#/$defs/bool", + "x-since-version": "v0.229.0" + }, + "pipeline_id": { + "description": "The full name of the pipeline task to execute.", + "$ref": "#/$defs/string", + "x-since-version": "v0.229.0" + } + }, + "additionalProperties": false, + "required": [ + "pipeline_id" + ] + }, + "jobs.PowerBiModel": { + "type": "object", + "properties": { + "authentication_method": { + "description": "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": "The name of the Power BI model", + "$ref": "#/$defs/string", + "x-since-version": "v0.248.0" + }, + "overwrite_existing": { + "description": "Whether to overwrite existing Power BI models", + "$ref": "#/$defs/bool", + "x-since-version": "v0.248.0" + }, + "storage_mode": { + "description": "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": "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": "The catalog name in Databricks", + "$ref": "#/$defs/string", + "x-since-version": "v0.248.0" + }, + "name": { + "description": "The table name in Databricks", + "$ref": "#/$defs/string", + "x-since-version": "v0.248.0" + }, + "schema": { + "description": "The schema name in Databricks", + "$ref": "#/$defs/string", + "x-since-version": "v0.248.0" + }, + "storage_mode": { + "description": "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": "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": "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": "Whether the model should be refreshed after the update", + "$ref": "#/$defs/bool", + "x-since-version": "v0.248.0" + }, + "tables": { + "description": "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": "The SQL warehouse ID to use as the Power BI data source", + "$ref": "#/$defs/string", + "x-since-version": "v0.248.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" + ] + }, + "jobs.RunJobTask": { + "type": "object", + "properties": { + "dbt_commands": { + "description": "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-preview": "PRIVATE", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v0.229.0", + "deprecated": true + }, + "jar_params": { + "description": "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-preview": "PRIVATE", + "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": "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-preview": "PRIVATE", + "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": { + "$ref": "#/$defs/map/string", + "x-databricks-preview": "PRIVATE", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v0.229.0", + "deprecated": true + }, + "python_params": { + "description": "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-preview": "PRIVATE", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v0.229.0", + "deprecated": true + }, + "spark_submit_params": { + "description": "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-preview": "PRIVATE", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v0.229.0", + "deprecated": true + }, + "sql_params": { + "description": "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-preview": "PRIVATE", + "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" + ] + }, + "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" + ] + }, + "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": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.248.0" + }, + "user_name": { + "$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": "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": "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": "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-preview": "PRIVATE", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v0.256.0", + "deprecated": true + }, + "dbt_platform_task": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask", + "x-databricks-preview": "PRIVATE", + "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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.243.0" + }, + "health": { + "$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": "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_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": "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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", + "x-databricks-preview": "PRIVATE", + "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": "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": "(Required, Mutable) Whether to enable auto full refresh or not.", + "$ref": "#/$defs/bool", + "x-since-version": "v0.285.0" + }, + "min_interval_hours": { + "description": "(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.ConnectionParameters": { + "type": "object", + "properties": { + "source_catalog": { + "description": "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-preview": "PRIVATE", + "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": { + "gdrive_options": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.298.0" + }, + "google_ads_options": { + "description": "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-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.298.0" + }, + "sharepoint_options": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.298.0" + }, + "tiktok_ads_options": { + "description": "TikTok Ads specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.298.0" + } + }, + "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" + ] + }, + "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": "(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": "(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": "(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" + ] + }, + "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": "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-since-version": "v0.298.0" + }, + "modified_before": { + "description": "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-since-version": "v0.298.0" + }, + "path_filter": { + "description": "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-since-version": "v0.298.0" + } + }, + "additionalProperties": false + }, + "pipelines.FileIngestionOptions": { + "type": "object", + "properties": { + "corrupt_record_column": { + "$ref": "#/$defs/string", + "x-since-version": "v0.298.0" + }, + "file_filters": { + "description": "Generic options", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", + "x-since-version": "v0.298.0" + }, + "format": { + "description": "required for TableSpec", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", + "x-since-version": "v0.298.0" + }, + "format_options": { + "description": "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-since-version": "v0.298.0" + }, + "ignore_corrupt_files": { + "$ref": "#/$defs/bool", + "x-since-version": "v0.298.0" + }, + "infer_column_types": { + "$ref": "#/$defs/bool", + "x-since-version": "v0.298.0" + }, + "reader_case_sensitive": { + "description": "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-since-version": "v0.298.0" + }, + "rescued_data_column": { + "$ref": "#/$defs/string", + "x-since-version": "v0.298.0" + }, + "schema_evolution_mode": { + "description": "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-since-version": "v0.298.0" + }, + "schema_hints": { + "description": "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-since-version": "v0.298.0" + }, + "single_variant_column": { + "$ref": "#/$defs/string", + "x-since-version": "v0.298.0" + } + }, + "additionalProperties": false + }, + "pipelines.FileIngestionOptionsFileFormat": { + "type": "string", + "enum": [ + "BINARYFILE", + "JSON", + "CSV", + "XML", + "EXCEL", + "PARQUET", + "AVRO", + "ORC" + ] + }, + "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" + ] + }, + "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.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": "(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-since-version": "v0.298.0" + }, + "manager_account_id": { + "description": "(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-since-version": "v0.298.0" + }, + "sync_start_date": { + "description": "(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-since-version": "v0.298.0" + } + }, + "additionalProperties": false, + "required": [ + "manager_account_id" + ] + }, + "pipelines.GoogleDriveOptions": { + "type": "object", + "properties": { + "entity_type": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", + "x-since-version": "v0.298.0" + }, + "file_ingestion_options": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-since-version": "v0.298.0" + }, + "url": { + "description": "Google Drive URL.", + "$ref": "#/$defs/string", + "x-since-version": "v0.298.0" + } + }, + "additionalProperties": false + }, + "pipelines.GoogleDriveOptionsGoogleDriveEntityType": { + "type": "string", + "enum": [ + "FILE", + "FILE_METADATA", + "PERMISSION" + ] + }, + "pipelines.IngestionConfig": { + "type": "object", + "properties": { + "report": { + "description": "Select a specific source report.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec", + "x-since-version": "v0.231.0" + }, + "schema": { + "description": "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": "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": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "$ref": "#/$defs/string", + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.229.0", + "deprecated": true + }, + "connection_name": { + "description": "Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "$ref": "#/$defs/string", + "x-since-version": "v0.234.0" + }, + "connection_parameters": { + "description": "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-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.279.0" + }, + "gateway_storage_catalog": { + "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", + "$ref": "#/$defs/string", + "x-since-version": "v0.229.0" + }, + "gateway_storage_name": { + "description": "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-since-version": "v0.229.0" + }, + "gateway_storage_schema": { + "description": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.", + "$ref": "#/$defs/string", + "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": "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": "(Optional) Connector Type for sources. Ex: CDC, Query Based.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.296.0" + }, + "data_staging_options": { + "description": "(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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.296.0" + }, + "full_refresh_window": { + "description": "(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": "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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.279.0" + }, + "ingestion_gateway_id": { + "description": "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": { + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.271.0" + }, + "objects": { + "description": "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": "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": "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": "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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.264.0" + }, + "deletion_condition": { + "description": "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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.264.0" + }, + "hard_deletion_sync_min_interval_in_seconds": { + "description": "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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.264.0" + } + }, + "additionalProperties": false + }, + "pipelines.IngestionPipelineDefinitionWorkdayReportParameters": { + "type": "object", + "properties": { + "incremental": { + "description": "(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", + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.271.0", + "deprecated": true + }, + "parameters": { + "description": "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-since-version": "v0.271.0" + }, + "report_parameters": { + "description": "(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", + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.271.0", + "deprecated": true + } + }, + "additionalProperties": false + }, + "pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue": { + "type": "object", + "properties": { + "key": { + "description": "Key for the report parameter, can be a column name or other metadata", + "$ref": "#/$defs/string", + "x-since-version": "v0.271.0" + }, + "value": { + "description": "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-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", + "FOREIGN_CATALOG" + ] + }, + "pipelines.ManualTrigger": { + "type": "object", + "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": "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": "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": "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.PathPattern": { + "type": "object", + "properties": { + "include": { + "description": "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": "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": "URI of the jar to be installed. Currently only DBFS is supported.", + "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.229.0" + }, + "maven": { + "description": "Specification of a maven library to be installed.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", + "x-databricks-preview": "PRIVATE", + "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 DLT's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip dependencies are supported.", + "properties": { + "dependencies": { + "description": "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": "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-preview": "PRIVATE", + "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": "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": "The name of the publication to use for the Postgres source", + "$ref": "#/$defs/string", + "x-since-version": "v0.267.0" + }, + "slot_name": { + "description": "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": "Required. Destination catalog to store table.", + "$ref": "#/$defs/string", + "x-since-version": "v0.231.0" + }, + "destination_schema": { + "description": "Required. Destination schema to store table.", + "$ref": "#/$defs/string", + "x-since-version": "v0.231.0" + }, + "destination_table": { + "description": "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": "Required. Report URL in the source system.", + "$ref": "#/$defs/string", + "x-since-version": "v0.231.0" + }, + "table_configuration": { + "description": "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": "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-since-version": "v0.234.0" + }, + "start_hour": { + "description": "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-since-version": "v0.234.0" + }, + "time_zone_id": { + "description": "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-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": "(Optional) Source Specific Connector Options", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.298.0" + }, + "destination_catalog": { + "description": "Required. Destination catalog to store tables.", + "$ref": "#/$defs/string", + "x-since-version": "v0.229.0" + }, + "destination_schema": { + "description": "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": "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": "Required. Schema name in the source database.", + "$ref": "#/$defs/string", + "x-since-version": "v0.229.0" + }, + "table_configuration": { + "description": "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": "(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-since-version": "v0.298.0" + }, + "file_ingestion_options": { + "description": "(Optional) File ingestion options for processing files.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-since-version": "v0.298.0" + }, + "url": { + "description": "Required. The SharePoint URL.", + "$ref": "#/$defs/string", + "x-since-version": "v0.298.0" + } + }, + "additionalProperties": false + }, + "pipelines.SharepointOptionsSharepointEntityType": { + "type": "string", + "enum": [ + "FILE", + "FILE_METADATA", + "PERMISSION", + "LIST" + ] + }, + "pipelines.SourceCatalogConfig": { + "type": "object", + "description": "SourceCatalogConfig contains catalog-level custom configuration parameters for each source", + "properties": { + "postgres": { + "description": "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": "Source catalog name", + "$ref": "#/$defs/string", + "x-since-version": "v0.267.0" + } + }, + "additionalProperties": false + }, + "pipelines.SourceConfig": { + "type": "object", + "properties": { + "catalog": { + "description": "Catalog-level source configuration parameters", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig", + "x-since-version": "v0.267.0" + } + }, + "additionalProperties": false + }, + "pipelines.TableSpec": { + "type": "object", + "properties": { + "connector_options": { + "description": "(Optional) Source Specific Connector Options", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.298.0" + }, + "destination_catalog": { + "description": "Required. Destination catalog to store table.", + "$ref": "#/$defs/string", + "x-since-version": "v0.229.0" + }, + "destination_schema": { + "description": "Required. Destination schema to store table.", + "$ref": "#/$defs/string", + "x-since-version": "v0.229.0" + }, + "destination_table": { + "description": "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": "Source catalog name. Might be optional depending on the type of source.", + "$ref": "#/$defs/string", + "x-since-version": "v0.229.0" + }, + "source_schema": { + "description": "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": "Required. Table name in the source database.", + "$ref": "#/$defs/string", + "x-since-version": "v0.229.0" + }, + "table_configuration": { + "description": "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": "(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" + }, + "exclude_columns": { + "description": "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": "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": "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": "Configurations that are only applicable for query-based ingestion connectors.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.264.0" + }, + "row_filter": { + "description": "(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-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.283.0" + }, + "salesforce_include_formula_fields": { + "description": "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-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.229.0" + }, + "scd_type": { + "description": "The SCD type to use to ingest the table.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.229.0" + }, + "sequence_by": { + "description": "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" + }, + "workday_report_parameters": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", + "x-databricks-preview": "PRIVATE", + "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" + ] + }, + "pipelines.TikTokAdsOptions": { + "type": "object", + "description": "TikTok Ads specific options for ingestion", + "properties": { + "data_level": { + "description": "(Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", + "x-since-version": "v0.298.0" + }, + "dimensions": { + "description": "(Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v0.298.0" + }, + "lookback_window_days": { + "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", + "$ref": "#/$defs/int", + "x-since-version": "v0.298.0" + }, + "metrics": { + "description": "(Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", + "$ref": "#/$defs/slice/string", + "x-since-version": "v0.298.0" + }, + "query_lifetime": { + "description": "(Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", + "$ref": "#/$defs/bool", + "x-since-version": "v0.298.0" + }, + "report_type": { + "description": "(Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", + "x-since-version": "v0.298.0" + }, + "sync_start_date": { + "description": "(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 1 year of historical data for daily reports\nand 30 days for hourly reports.", + "$ref": "#/$defs/string", + "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" + ] + }, + "pipelines.TikTokAdsOptionsTikTokReportType": { + "type": "string", + "description": "Report type for TikTok Ads API.", + "enum": [ + "BASIC", + "AUDIENCE", + "PLAYABLE_AD", + "DSA", + "BUSINESS_CENTER", + "GMV_MAX" + ] + }, + "postgres.EndpointGroupSpec": { + "type": "object", + "properties": { + "enable_readable_secondaries": { + "description": "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": "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": "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": "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" + ] + }, + "postgres.ProjectCustomTag": { + "type": "object", + "properties": { + "key": { + "description": "The key of the custom tag.", + "$ref": "#/$defs/string", + "x-since-version": "v0.290.0" + }, + "value": { + "description": "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": "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": "The minimum number of Compute Units. Minimum value is 0.5.", + "$ref": "#/$defs/float64", + "x-since-version": "v0.287.0" + }, + "no_suspension": { + "description": "When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.", + "$ref": "#/$defs/bool", + "x-since-version": "v0.287.0" + }, + "pg_settings": { + "description": "A raw representation of Postgres settings.", + "$ref": "#/$defs/map/string", + "x-since-version": "v0.287.0" + }, + "suspend_timeout_duration": { + "description": "Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-since-version": "v0.287.0" + } + }, + "additionalProperties": false + }, + "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": "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": "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": "Configuration for guardrail PII filter.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior", + "x-since-version": "v0.230.0" + }, + "safety": { + "description": "Indicates whether the safety filter is enabled.", + "$ref": "#/$defs/bool", + "x-since-version": "v0.230.0" + }, + "valid_topics": { + "description": "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": "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" + ] + }, + "serving.AiGatewayGuardrails": { + "type": "object", + "properties": { + "input": { + "description": "Configuration for input guardrail filters.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", + "x-since-version": "v0.230.0" + }, + "output": { + "description": "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" + ] + }, + "serving.AiGatewayRateLimitRenewalPeriod": { + "type": "string", + "enum": [ + "minute" + ] + }, + "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" + ] + }, + "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", + "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 Inference Tables which automatically logs requests and responses to Unity Catalog.\nNote: this field is deprecated for creating new provisioned throughput endpoints,\nor updating existing provisioned throughput endpoints that never have inference table configured;\nin these cases please use AI Gateway to manage inference tables.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AutoCaptureConfigInput", + "x-since-version": "v0.229.0" + }, + "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" + ] + }, + "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" + ] + }, + "serving.RateLimitRenewalPeriod": { + "type": "string", + "enum": [ + "minute" + ] + }, + "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": "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": "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": "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": "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": "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": "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 with workload types in InferenceEndpointEntities.scala", + "enum": [ + "CPU", + "GPU_MEDIUM", + "GPU_SMALL", + "GPU_LARGE", + "MULTIGPU_MEDIUM" + ] + }, + "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 with workload types in InferenceEndpointEntities.scala", + "enum": [ + "CPU", + "GPU_MEDIUM", + "GPU_SMALL", + "GPU_LARGE", + "MULTIGPU_MEDIUM" + ] + }, + "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" + ] + }, + "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" + ] + }, + "sql.AlertLifecycleState": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED" + ] + }, + "sql.AlertV2Evaluation": { + "type": "object", + "properties": { + "comparison_operator": { + "description": "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": "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": "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": "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": "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": "Whether to notify alert subscribers when alert returns back to normal.", + "$ref": "#/$defs/bool", + "x-since-version": "v0.279.0" + }, + "retrigger_seconds": { + "description": "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": { + "$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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", + "x-since-version": "v0.279.0" + }, + "value": { + "$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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation", + "x-since-version": "v0.279.0" + }, + "display": { + "$ref": "#/$defs/string", + "x-since-version": "v0.279.0" + }, + "name": { + "$ref": "#/$defs/string", + "x-since-version": "v0.279.0" + } + }, + "additionalProperties": false, + "required": [ + "name" + ] + }, + "sql.AlertV2OperandValue": { + "type": "object", + "properties": { + "bool_value": { + "$ref": "#/$defs/bool", + "x-since-version": "v0.279.0" + }, + "double_value": { + "$ref": "#/$defs/float64", + "x-since-version": "v0.279.0" + }, + "string_value": { + "$ref": "#/$defs/string", + "x-since-version": "v0.279.0" + } + }, + "additionalProperties": false + }, + "sql.AlertV2RunAs": { + "type": "object", + "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.279.0" + }, + "user_name": { + "description": "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": { + "$ref": "#/$defs/string", + "x-since-version": "v0.279.0" + }, + "user_email": { + "$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" + ] + }, + "sql.CreateWarehouseRequestWarehouseType": { + "type": "string", + "enum": [ + "TYPE_UNSPECIFIED", + "CLASSIC", + "PRO" + ] + }, + "sql.CronSchedule": { + "type": "object", + "properties": { + "pause_status": { + "description": "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": "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": "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" + ] + }, + "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+-------+--------------------------------------+--------------------------------+\n\nWhile including \"spot\" in the enum name may limit the the future\nextensibility of this field because it limits this enum to denoting \"spot or\nnot\", this is the field that PM recommends after discussion with customers\nper SC-48783.", + "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.EndpointType": { + "type": "string", + "description": "Type of endpoint.", + "enum": [ + "STORAGE_OPTIMIZED", + "STANDARD" + ] + }, + "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.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.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.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.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" + } + }, + "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.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" + } + }, + "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" + } + } + } + } + } + }, + "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 From 9361922dc44aec26821d223a18f47fd799032063 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 13 May 2026 14:21:47 +0000 Subject: [PATCH 04/31] Update jsonschema_for_docs.json for v0.299.2 --- bundle/schema/jsonschema_for_docs.json | 414 ++++++++++++++++++++++--- 1 file changed, 370 insertions(+), 44 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index dd36c9aef60..420ca249723 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -108,8 +108,6 @@ "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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.283.0" }, "git_source": { @@ -247,8 +245,6 @@ "managed_encryption_settings": { "description": "Control CMK encryption for managed catalog data", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionSettings", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.298.0" }, "name": { @@ -1169,7 +1165,7 @@ "x-since-version": "v0.229.0" }, "channel": { - "description": "DLT Release Channel that specifies which version to use.", + "description": "SDP Release Channel that specifies which version to use.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, @@ -1937,10 +1933,6 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.298.0" }, - "min_qps": { - "$ref": "#/$defs/int64", - "x-since-version": "v0.298.0" - }, "name": { "$ref": "#/$defs/string", "x-since-version": "v0.298.0" @@ -1949,6 +1941,10 @@ "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", "x-since-version": "v0.298.0" }, + "target_qps": { + "$ref": "#/$defs/int64", + "x-since-version": "v0.299.2" + }, "usage_policy_id": { "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", @@ -2801,8 +2797,6 @@ "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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.283.0" }, "mode": { @@ -3215,7 +3209,8 @@ "type": "string", "enum": [ "MEDIUM", - "LARGE" + "LARGE", + "LIQUID" ] }, "apps.ComputeState": { @@ -3720,7 +3715,19 @@ "CREATE_CLEAN_ROOM", "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", - "EXTERNAL_USE_SCHEMA" + "EXTERNAL_USE_SCHEMA", + "VIEW_OBJECT", + "MANAGE_GRANTS", + "INSERT", + "UPDATE", + "DELETE", + "VIEW_ADMIN_METADATA", + "VIEW_METADATA", + "USE_VOLUME", + "READ_METADATA", + "MANAGE_ACCESS", + "MANAGE_ACCESS_CONTROL", + "CREATE_SERVICE" ] }, "catalog.PrivilegeAssignment": { @@ -4152,6 +4159,14 @@ }, "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" + ] + }, "compute.DataSecurityMode": { "type": "string", "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\nThe following modes can only be used when `kind = CLASSIC_PREVIEW`.\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\n\nThe following modes can be used regardless of `kind`.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n* `SINGLE_USER`: 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* `USER_ISOLATION`: 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\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.", @@ -4224,7 +4239,7 @@ }, "compute.Environment": { "type": "object", - "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and DLT's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip and java dependencies are supported.", + "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. For more information, see", @@ -4268,6 +4283,13 @@ "$ref": "#/$defs/int", "x-since-version": "v0.229.0" }, + "confidential_compute_type": { + "description": "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-preview": "PRIVATE", + "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", @@ -4327,7 +4349,8 @@ "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" + "GPU_8xH100", + "GPU_1xH100" ] }, "compute.InitScriptInfo": { @@ -4678,7 +4701,8 @@ "DELETING", "STOPPED", "UPDATING", - "FAILING_OVER" + "FAILING_OVER", + "MIGRATING" ] }, "database.DeltaTableSyncInfo": { @@ -4872,7 +4896,8 @@ "CAN_MONITOR", "CAN_CREATE", "CAN_MONITOR_ONLY", - "CAN_CREATE_APP" + "CAN_CREATE_APP", + "UNSPECIFIED" ] }, "jobs.AlertTask": { @@ -5735,7 +5760,7 @@ "type": "object", "properties": { "full_refresh": { - "description": "If true, triggers a full refresh on the delta live table.", + "description": "If true, triggers a full refresh on the spark declarative pipeline.", "$ref": "#/$defs/bool", "x-since-version": "v0.229.0" } @@ -5746,7 +5771,7 @@ "type": "object", "properties": { "full_refresh": { - "description": "If true, triggers a full refresh on the delta live table.", + "description": "If true, triggers a full refresh on the spark declarative pipeline.", "$ref": "#/$defs/bool", "x-since-version": "v0.229.0" }, @@ -6730,6 +6755,18 @@ "enabled" ] }, + "pipelines.ConfluenceConnectorOptions": { + "type": "object", + "description": "Confluence specific options for ingestion", + "properties": { + "include_confluence_spaces": { + "description": "(Optional) Spaces to filter Confluence data on", + "$ref": "#/$defs/slice/string", + "x-since-version": "v0.299.2" + } + }, + "additionalProperties": false + }, "pipelines.ConnectionParameters": { "type": "object", "properties": { @@ -6747,6 +6784,11 @@ "type": "object", "description": "Wrapper message for source-specific options to support multiple connector types", "properties": { + "confluence_options": { + "description": "Confluence specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions", + "x-since-version": "v0.299.2" + }, "gdrive_options": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions", "x-databricks-preview": "PRIVATE", @@ -6760,18 +6802,49 @@ "doNotSuggest": true, "x-since-version": "v0.298.0" }, + "jira_options": { + "description": "Jira specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", + "x-since-version": "v0.299.2" + }, + "meta_ads_options": { + "description": "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": "Outlook specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.299.2" + }, "sharepoint_options": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, + "smartsheet_options": { + "description": "Smartsheet specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.299.2" + }, "tiktok_ads_options": { "description": "TikTok Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" + }, + "zendesk_support_options": { + "description": "Zendesk Support specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.299.2" } }, "additionalProperties": false @@ -6994,6 +7067,17 @@ }, "additionalProperties": false }, + "pipelines.GoogleAdsConfig": { + "type": "object", + "properties": { + "manager_account_id": { + "description": "(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-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).", @@ -7142,8 +7226,6 @@ "ingest_from_uc_foreign_catalog": { "description": "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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.279.0" }, "ingestion_gateway_id": { @@ -7182,22 +7264,16 @@ "cursor_columns": { "description": "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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.264.0" }, "deletion_condition": { "description": "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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.264.0" }, "hard_deletion_sync_min_interval_in_seconds": { "description": "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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.264.0" } }, @@ -7249,6 +7325,8 @@ "enum": [ "MYSQL", "POSTGRESQL", + "REDSHIFT", + "SQLDW", "SQLSERVER", "SALESFORCE", "BIGQUERY", @@ -7262,13 +7340,155 @@ "SHAREPOINT", "DYNAMICS365", "GOOGLE_DRIVE", + "JIRA", + "CONFLUENCE", + "META_MARKETING", + "GOOGLE_ADS", + "TIKTOK_ADS", + "SALESFORCE_MARKETING_CLOUD", + "HUBSPOT", + "WORKDAY_HCM", + "GUIDEWIRE", + "ZENDESK", + "COMMUNITY", + "SLACK_AUDIT_LOGS", + "KAFKA", + "CROWDSTRIKE_EVENT_STREAM", + "WORKDAY_ACTIVITY_LOGGING", + "AKAMAI_WAF", + "VEEVA", + "VEEVA_VAULT", + "M365_AUDIT_LOGS", + "OKTA_SYSTEM_LOGS", + "ONE_PASSWORD_EVENT_LOGS", + "PROOFPOINT_SIEM", + "WIZ_AUDIT_LOGS", + "GITHUB", + "OUTLOOK", + "SMARTSHEET", + "MICROSOFT_TEAMS", + "ADOBE_CAMPAIGNS", + "LINKEDIN_ADS", + "X_ADS", + "BING_ADS", + "GOOGLE_SEARCH_CONSOLE", + "PINTEREST_ADS", + "REDDIT_ADS", + "PENDO", + "API_SOURCE", + "SLACK_ACCESS_AND_INTEGRATION_LOGS", + "ORACLE_FUSION_CLOUD", + "RABBITMQ", + "GOOGLE_ANALYTICS", + "AMPLITUDE", + "NOTION", + "ADP_WORKFORCE_NOW", + "SAS", + "GONG", + "SALESLOFT", + "GOOGLE_WORKSPACE", + "SHOPIFY", + "ORACLE_ELOQUA", + "EPIC_CLARITY", + "LINEAR", + "APPLE_APP_STORE", + "SPLUNK", + "GITLAB", + "ZOOM_LOGS", + "MONDAY_COM", + "AIRTABLE", + "MICROSOFT_ENTRA_ID", + "PAGERDUTY", + "APPFIGURES", + "ADOBE_COMMERCE", + "QUICKBOOKS", + "SQUARE", + "ZOHO_BOOKS", + "SNAPCHAT_ADS", + "GENESYS", + "SAP_SUCCESSFACTORS", + "YOUTUBE_ANALYTICS", + "CERIDIAN_DAYFORCE", + "FRESHSERVICE", + "SENDGRID", + "AZURE_MONITOR_LOGS", + "ATLASSIAN_ORGANIZATION", + "HIBOB", + "APPLE_SEARCH_ADS", + "AWIN", + "DELIGHTED", + "FRONT", + "GURU", + "PARTNERSTACK", + "MARKETO", + "AHA", + "NETSKOPE_LOGS", "FOREIGN_CATALOG" ] }, + "pipelines.JiraConnectorOptions": { + "type": "object", + "description": "Jira specific options for ingestion", + "properties": { + "include_jira_spaces": { + "description": "(Optional) Projects to filter Jira data on", + "$ref": "#/$defs/slice/string", + "x-since-version": "v0.299.2" + } + }, + "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": "(Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", + "$ref": "#/$defs/slice/string", + "x-since-version": "v0.299.2" + }, + "action_breakdowns": { + "description": "(Optional) Action breakdowns to configure for data aggregation", + "$ref": "#/$defs/slice/string", + "x-since-version": "v0.299.2" + }, + "action_report_time": { + "description": "(Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", + "$ref": "#/$defs/string", + "x-since-version": "v0.299.2" + }, + "breakdowns": { + "description": "(Optional) Breakdowns to configure for data aggregation", + "$ref": "#/$defs/slice/string", + "x-since-version": "v0.299.2" + }, + "custom_insights_lookback_window": { + "description": "(Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", + "$ref": "#/$defs/int", + "x-since-version": "v0.299.2" + }, + "level": { + "description": "(Optional) Granularity of data to pull (account, ad, adset, campaign)", + "$ref": "#/$defs/string", + "x-since-version": "v0.299.2" + }, + "start_date": { + "description": "(Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested", + "$ref": "#/$defs/string", + "x-since-version": "v0.299.2" + }, + "time_increment": { + "description": "(Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", + "$ref": "#/$defs/string", + "x-since-version": "v0.299.2" + } + }, + "additionalProperties": false + }, "pipelines.NotebookLibrary": { "type": "object", "properties": { @@ -7321,6 +7541,87 @@ "start_hour" ] }, + "pipelines.OutlookAttachmentMode": { + "type": "string", + "description": "Attachment behavior mode for Outlook ingestion", + "enum": [ + "ALL", + "NON_INLINE_ONLY", + "INLINE_ONLY", + "NONE" + ] + }, + "pipelines.OutlookBodyFormat": { + "type": "string", + "description": "Body format for Outlook email content", + "enum": [ + "TEXT_HTML", + "TEXT_PLAIN" + ] + }, + "pipelines.OutlookOptions": { + "type": "object", + "description": "Outlook specific options for ingestion", + "properties": { + "attachment_mode": { + "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", + "x-since-version": "v0.299.2" + }, + "body_format": { + "description": "(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-since-version": "v0.299.2" + }, + "folder_filter": { + "description": "Deprecated. Use include_folders instead.", + "$ref": "#/$defs/slice/string", + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.299.2", + "deprecated": true + }, + "include_folders": { + "description": "(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-since-version": "v0.299.2" + }, + "include_mailboxes": { + "description": "(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-since-version": "v0.299.2" + }, + "include_senders": { + "description": "(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-since-version": "v0.299.2" + }, + "include_subjects": { + "description": "(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-since-version": "v0.299.2" + }, + "sender_filter": { + "description": "Deprecated. Use include_senders instead.", + "$ref": "#/$defs/slice/string", + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.299.2", + "deprecated": true + }, + "start_date": { + "description": "(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-since-version": "v0.299.2" + }, + "subject_filter": { + "description": "Deprecated. Use include_subjects instead.", + "$ref": "#/$defs/slice/string", + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.299.2", + "deprecated": true + } + }, + "additionalProperties": false + }, "pipelines.PathPattern": { "type": "object", "properties": { @@ -7553,7 +7854,7 @@ }, "pipelines.PipelinesEnvironment": { "type": "object", - "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and DLT's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip dependencies are supported.", + "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": "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", @@ -7682,8 +7983,6 @@ "connector_options": { "description": "(Optional) Source Specific Connector Options", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.298.0" }, "destination_catalog": { @@ -7749,6 +8048,18 @@ "LIST" ] }, + "pipelines.SmartsheetOptions": { + "type": "object", + "description": "Smartsheet specific options for ingestion", + "properties": { + "enforce_schema": { + "description": "(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-since-version": "v0.299.2" + } + }, + "additionalProperties": false + }, "pipelines.SourceCatalogConfig": { "type": "object", "description": "SourceCatalogConfig contains catalog-level custom configuration parameters for each source", @@ -7773,6 +8084,12 @@ "description": "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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v0.299.2" } }, "additionalProperties": false @@ -7783,8 +8100,6 @@ "connector_options": { "description": "(Optional) Source Specific Connector Options", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.298.0" }, "destination_catalog": { @@ -7856,15 +8171,11 @@ "query_based_connector_config": { "description": "Configurations that are only applicable for query-based ingestion connectors.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.264.0" }, "row_filter": { "description": "(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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.283.0" }, "salesforce_include_formula_fields": { @@ -7877,8 +8188,6 @@ "scd_type": { "description": "The SCD type to use to ingest the table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.229.0" }, "sequence_by": { @@ -7968,6 +8277,18 @@ "GMV_MAX" ] }, + "pipelines.ZendeskSupportOptions": { + "type": "object", + "description": "Zendesk Support specific options for ingestion", + "properties": { + "start_date": { + "description": "(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-since-version": "v0.299.2" + } + }, + "additionalProperties": false + }, "postgres.EndpointGroupSpec": { "type": "object", "properties": { @@ -8044,7 +8365,7 @@ "x-since-version": "v0.287.0" }, "no_suspension": { - "description": "When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.", + "description": "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" }, @@ -8054,7 +8375,7 @@ "x-since-version": "v0.287.0" }, "suspend_timeout_duration": { - "description": "Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).", + "description": "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" } @@ -8355,6 +8676,7 @@ }, "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.", @@ -8485,9 +8807,11 @@ "type": "object", "properties": { "auto_capture_config": { - "description": "Configuration for Inference Tables which automatically logs requests and responses to Unity Catalog.\nNote: this field is deprecated for creating new provisioned throughput endpoints,\nor updating existing provisioned throughput endpoints that never have inference table configured;\nin these cases please use AI Gateway to manage inference tables.", + "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", - "x-since-version": "v0.229.0" + "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.", @@ -9205,7 +9529,8 @@ "enum": [ "TYPE_UNSPECIFIED", "CLASSIC", - "PRO" + "PRO", + "REYDEN" ] }, "sql.CronSchedule": { @@ -9289,7 +9614,8 @@ "description": "Type of endpoint.", "enum": [ "STORAGE_OPTIMIZED", - "STANDARD" + "STANDARD", + "STANDARD_ON_ORION" ] }, "workspace.AzureKeyVaultSecretScopeMetadata": { From fefae2ee97f2a6a0dcce3e59131f7713d4ad3d60 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 21 May 2026 08:10:01 +0000 Subject: [PATCH 05/31] Update jsonschema_for_docs.json for v1.0.0 --- bundle/schema/jsonschema_for_docs.json | 134 +++++++++++++++++++++++++ 1 file changed, 134 insertions(+) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 420ca249723..6828e3c102b 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -1368,6 +1368,10 @@ "$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" @@ -1391,6 +1395,36 @@ "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.PostgresEndpoint": { "type": "object", "properties": { @@ -1430,6 +1464,10 @@ "$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" @@ -1499,6 +1537,59 @@ "project_id" ] }, + "resources.PostgresSyncedTable": { + "type": "object", + "properties": { + "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" + } + }, + "additionalProperties": false, + "required": [ + "synced_table_id" + ] + }, "resources.QualityMonitor": { "type": "object", "properties": { @@ -2487,6 +2578,11 @@ "$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_endpoints": { "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresEndpoint", "x-since-version": "v0.287.0" @@ -2495,6 +2591,11 @@ "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresProject", "x-since-version": "v0.287.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", @@ -8334,6 +8435,24 @@ "ENDPOINT_TYPE_READ_ONLY" ] }, + "postgres.NewPipelineSpec": { + "type": "object", + "properties": { + "budget_policy_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" + }, + "storage_catalog": { + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" + }, + "storage_schema": { + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" + } + }, + "additionalProperties": false + }, "postgres.ProjectCustomTag": { "type": "object", "properties": { @@ -8382,6 +8501,9 @@ }, "additionalProperties": false }, + "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy": { + "type": "string" + }, "serving.Ai21LabsConfig": { "type": "object", "properties": { @@ -9748,6 +9870,12 @@ "$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.PostgresEndpoint": { "type": "object", "additionalProperties": { @@ -9760,6 +9888,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresProject" } }, + "resources.PostgresSyncedTable": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresSyncedTable" + } + }, "resources.QualityMonitor": { "type": "object", "additionalProperties": { From 65245bd23350fcb228dda4e336873a7959e72af7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 27 May 2026 15:01:56 +0000 Subject: [PATCH 06/31] Update jsonschema_for_docs.json for v1.1.0 --- bundle/schema/jsonschema_for_docs.json | 399 ++++++++++++++++++++++++- 1 file changed, 386 insertions(+), 13 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 6828e3c102b..d84ffda3158 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -113,6 +113,8 @@ "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-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.290.0" }, "lifecycle": { @@ -136,6 +138,8 @@ }, "source_code_path": { "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v0.239.0" }, "space": { @@ -380,7 +384,7 @@ }, "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", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", "x-since-version": "v0.268.0" }, "node_type_id": { @@ -2049,6 +2053,54 @@ "name" ] }, + "resources.VectorSearchIndex": { + "type": "object", + "properties": { + "delta_sync_index_spec": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.DeltaSyncVectorIndexSpecRequest", + "x-since-version": "v1.1.0" + }, + "direct_access_index_spec": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.DirectAccessVectorIndexSpec", + "x-since-version": "v1.1.0" + }, + "endpoint_name": { + "$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": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype", + "x-since-version": "v1.1.0" + }, + "index_type": { + "$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": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "primary_key": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + } + }, + "additionalProperties": false, + "required": [ + "endpoint_name", + "index_type", + "name", + "primary_key" + ] + }, "resources.Volume": { "type": "object", "properties": { @@ -2634,6 +2686,10 @@ "$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", @@ -3828,7 +3884,9 @@ "READ_METADATA", "MANAGE_ACCESS", "MANAGE_ACCESS_CONTROL", - "CREATE_SERVICE" + "CREATE_SERVICE", + "CREATE_FEATURE", + "READ_FEATURE" ] }, "catalog.PrivilegeAssignment": { @@ -4270,7 +4328,7 @@ }, "compute.DataSecurityMode": { "type": "string", - "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\nThe following modes can only be used when `kind = CLASSIC_PREVIEW`.\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\n\nThe following modes can be used regardless of `kind`.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n* `SINGLE_USER`: 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* `USER_ISOLATION`: 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\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.", + "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", @@ -4343,7 +4401,7 @@ "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. For more information, see", + "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" }, @@ -4803,7 +4861,7 @@ "STOPPED", "UPDATING", "FAILING_OVER", - "MIGRATING" + "UPGRADING" ] }, "database.DeltaTableSyncInfo": { @@ -5864,6 +5922,26 @@ "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": "A list of tables to update with fullRefresh.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.1.0" + }, + "refresh_flow_selection": { + "description": "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": "A list of tables to update without fullRefresh.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.1.0" + }, + "reset_checkpoint_selection": { + "description": "A list of streaming flows to reset checkpoints without clearing data.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.1.0" } }, "additionalProperties": false @@ -5876,10 +5954,30 @@ "$ref": "#/$defs/bool", "x-since-version": "v0.229.0" }, + "full_refresh_selection": { + "description": "A list of tables to update with fullRefresh.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.1.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": "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": "A list of tables to update without fullRefresh.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.1.0" + }, + "reset_checkpoint_selection": { + "description": "A list of streaming flows to reset checkpoints without clearing data.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.1.0" } }, "additionalProperties": false, @@ -5975,6 +6073,36 @@ }, "additionalProperties": false }, + "jobs.PythonOperatorTask": { + "type": "object", + "properties": { + "main": { + "description": "Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "parameters": { + "description": "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-since-version": "v1.1.0" + } + }, + "additionalProperties": false + }, + "jobs.PythonOperatorTaskParameter": { + "type": "object", + "properties": { + "name": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "value": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + } + }, + "additionalProperties": false + }, "jobs.PythonWheelTask": { "type": "object", "properties": { @@ -6479,8 +6607,6 @@ "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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.271.0" }, "email_notifications": { @@ -6558,6 +6684,13 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask", "x-since-version": "v0.248.0" }, + "python_operator_task": { + "description": "The task runs a Python operator task.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask", + "x-databricks-preview": "PRIVATE", + "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", @@ -6908,6 +7041,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", "x-since-version": "v0.299.2" }, + "kafka_options": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v1.1.0" + }, "meta_ads_options": { "description": "Meta Marketing (Meta Ads) specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", @@ -7127,7 +7266,8 @@ "EXCEL", "PARQUET", "AVRO", - "ORC" + "ORC", + "FILE" ] }, "pipelines.FileIngestionOptionsSchemaEvolutionMode": { @@ -7228,7 +7368,9 @@ "enum": [ "FILE", "FILE_METADATA", - "PERMISSION" + "PERMISSION", + "FILE_PERMISSION", + "GROUP_MEMBERSHIP" ] }, "pipelines.IngestionConfig": { @@ -7539,6 +7681,82 @@ }, "additionalProperties": false }, + "pipelines.JsonTransformerOptions": { + "type": "object", + "properties": { + "as_variant": { + "description": "Parse the entire value as a single Variant column.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.1.0" + }, + "schema": { + "description": "Inline schema string for JSON parsing (Spark DDL format).", + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "schema_evolution_mode": { + "description": "(Optional) Schema evolution mode for schema inference.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", + "x-since-version": "v1.1.0" + }, + "schema_file_path": { + "description": "Path to a schema file (.ddl).", + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "schema_hints": { + "description": "(Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + } + }, + "additionalProperties": false + }, + "pipelines.KafkaOptions": { + "type": "object", + "properties": { + "client_config": { + "description": "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-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v1.1.0" + }, + "key_transformer": { + "description": "(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-since-version": "v1.1.0" + }, + "max_offsets_per_trigger": { + "description": "Internal option to control the maximum number of offsets to process per trigger.", + "$ref": "#/$defs/int64", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, + "x-since-version": "v1.1.0" + }, + "starting_offset": { + "description": "(Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "topic_pattern": { + "description": "Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "topics": { + "description": "Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.1.0" + }, + "value_transformer": { + "description": "(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-since-version": "v1.1.0" + } + }, + "additionalProperties": false + }, "pipelines.ManualTrigger": { "type": "object", "additionalProperties": false @@ -8146,7 +8364,9 @@ "FILE", "FILE_METADATA", "PERMISSION", - "LIST" + "LIST", + "FILE_PERMISSION", + "GROUP_MEMBERSHIP" ] }, "pipelines.SmartsheetOptions": { @@ -8378,6 +8598,31 @@ "GMV_MAX" ] }, + "pipelines.Transformer": { + "type": "object", + "description": "Specifies how to transform binary data into structured data.", + "properties": { + "format": { + "description": "Required: the wire format of the data.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", + "x-since-version": "v1.1.0" + }, + "json_options": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", + "x-since-version": "v1.1.0" + } + }, + "additionalProperties": false + }, + "pipelines.TransformerFormat": { + "type": "string", + "enum": [ + "STRING", + "JSON", + "AVRO", + "PROTOBUF" + ] + }, "pipelines.ZendeskSupportOptions": { "type": "object", "description": "Zendesk Support specific options for ingestion", @@ -8439,14 +8684,17 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "storage_catalog": { + "description": "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": "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" } @@ -8502,7 +8750,13 @@ "additionalProperties": false }, "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy": { - "type": "string" + "type": "string", + "description": "Scheduling policy of the synced table's underlying pipeline.", + "enum": [ + "CONTINUOUS", + "TRIGGERED", + "SNAPSHOT" + ] }, "serving.Ai21LabsConfig": { "type": "object", @@ -9407,7 +9661,8 @@ "GPU_MEDIUM", "GPU_SMALL", "GPU_LARGE", - "MULTIGPU_MEDIUM" + "MULTIGPU_MEDIUM", + "GPU_XLARGE" ] }, "serving.ServingEndpointPermissionLevel": { @@ -9427,7 +9682,8 @@ "GPU_MEDIUM", "GPU_SMALL", "GPU_LARGE", - "MULTIGPU_MEDIUM" + "MULTIGPU_MEDIUM", + "GPU_XLARGE" ] }, "serving.TrafficConfig": { @@ -9731,6 +9987,90 @@ "CAN_VIEW" ] }, + "vectorsearch.DeltaSyncVectorIndexSpecRequest": { + "type": "object", + "properties": { + "columns_to_index": { + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.1.0" + }, + "columns_to_sync": { + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.1.0" + }, + "embedding_source_columns": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", + "x-since-version": "v1.1.0" + }, + "embedding_vector_columns": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", + "x-since-version": "v1.1.0" + }, + "embedding_writeback_table": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "pipeline_type": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.PipelineType", + "x-since-version": "v1.1.0" + }, + "source_table": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + } + }, + "additionalProperties": false + }, + "vectorsearch.DirectAccessVectorIndexSpec": { + "type": "object", + "properties": { + "embedding_source_columns": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", + "x-since-version": "v1.1.0" + }, + "embedding_vector_columns": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", + "x-since-version": "v1.1.0" + }, + "schema_json": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + } + }, + "additionalProperties": false + }, + "vectorsearch.EmbeddingSourceColumn": { + "type": "object", + "properties": { + "embedding_model_endpoint_name": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "model_endpoint_name_for_query": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + }, + "name": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + } + }, + "additionalProperties": false + }, + "vectorsearch.EmbeddingVectorColumn": { + "type": "object", + "properties": { + "embedding_dimension": { + "$ref": "#/$defs/int", + "x-since-version": "v1.1.0" + }, + "name": { + "$ref": "#/$defs/string", + "x-since-version": "v1.1.0" + } + }, + "additionalProperties": false + }, "vectorsearch.EndpointType": { "type": "string", "description": "Type of endpoint.", @@ -9740,6 +10080,15 @@ "STANDARD_ON_ORION" ] }, + "vectorsearch.IndexSubtype": { + "type": "string" + }, + "vectorsearch.PipelineType": { + "type": "string" + }, + "vectorsearch.VectorIndexType": { + "type": "string" + }, "workspace.AzureKeyVaultSecretScopeMetadata": { "type": "object", "description": "The metadata of the Azure KeyVault for a secret scope of type `AZURE_KEYVAULT`", @@ -9936,6 +10285,12 @@ "$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": { @@ -10175,6 +10530,12 @@ "$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": { @@ -10318,6 +10679,18 @@ "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" + } } } } From eb1d3889e3dffbd7e1055918aa1275568c67a8b4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 4 Jun 2026 09:11:06 +0000 Subject: [PATCH 07/31] Update jsonschema_for_docs.json for v1.2.0 --- bundle/schema/jsonschema_for_docs.json | 43 +++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index d84ffda3158..8e2b26c1309 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -92,6 +92,14 @@ "$ref": "#/$defs/string", "x-since-version": "v0.243.0" }, + "compute_max_instances": { + "$ref": "#/$defs/int", + "x-since-version": "v1.2.0" + }, + "compute_min_instances": { + "$ref": "#/$defs/int", + "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" @@ -1250,6 +1258,10 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications", "x-since-version": "v0.229.0" }, + "parameters": { + "$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" @@ -1534,6 +1546,10 @@ "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, @@ -1921,7 +1937,7 @@ }, "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", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", "x-since-version": "v0.268.0" }, "max_num_clusters": { @@ -2422,6 +2438,11 @@ "$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", @@ -5556,6 +5577,10 @@ "jobs.JobDeployment": { "type": "object", "properties": { + "deployment_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.2.0" + }, "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", @@ -5565,6 +5590,10 @@ "description": "Path of the file that contains deployment metadata.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" + }, + "version_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.2.0" } }, "additionalProperties": false, @@ -5959,6 +5988,10 @@ "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, + "parameters": { + "$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", @@ -8089,6 +8122,10 @@ "pipelines.PipelineDeployment": { "type": "object", "properties": { + "deployment_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.2.0" + }, "kind": { "description": "The deployment method that manages the pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind", @@ -8098,6 +8135,10 @@ "description": "The path to the file containing metadata about the deployment.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" + }, + "version_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.2.0" } }, "additionalProperties": false, From edd0e38ff81d684e7a2038ba604df2e9ae901bdc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 10 Jun 2026 15:17:57 +0000 Subject: [PATCH 08/31] Update jsonschema_for_docs.json for v1.3.0 --- bundle/schema/jsonschema_for_docs.json | 109 +++++++++++++++++++++++-- 1 file changed, 101 insertions(+), 8 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 8e2b26c1309..7a18f1aeb8e 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -94,10 +94,14 @@ }, "compute_max_instances": { "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.2.0" }, "compute_min_instances": { "$ref": "#/$defs/int", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.2.0" }, "compute_size": { @@ -743,6 +747,54 @@ "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": { @@ -2623,6 +2675,10 @@ "$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", @@ -3907,7 +3963,12 @@ "MANAGE_ACCESS_CONTROL", "CREATE_SERVICE", "CREATE_FEATURE", - "READ_FEATURE" + "READ_FEATURE", + "CREATE_STREAM", + "READ_STREAM", + "CREATE_MEMORY_STORE", + "READ_MEMORY_STORE", + "WRITE_MEMORY_STORE" ] }, "catalog.PrivilegeAssignment": { @@ -5578,7 +5639,10 @@ "type": "object", "properties": { "deployment_id": { + "description": "ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.2.0" }, "kind": { @@ -5592,7 +5656,10 @@ "x-since-version": "v0.229.0" }, "version_id": { + "description": "ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.2.0" } }, @@ -5989,6 +6056,7 @@ "x-since-version": "v1.1.0" }, "parameters": { + "description": "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" }, @@ -7483,15 +7551,11 @@ "connector_type": { "description": "(Optional) Connector Type for sources. Ex: CDC, Query Based.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.296.0" }, "data_staging_options": { "description": "(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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.296.0" }, "full_refresh_window": { @@ -8123,7 +8187,10 @@ "type": "object", "properties": { "deployment_id": { + "description": "ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.2.0" }, "kind": { @@ -8137,7 +8204,10 @@ "x-since-version": "v0.229.0" }, "version_id": { + "description": "ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", "$ref": "#/$defs/string", + "x-databricks-preview": "PRIVATE", + "doNotSuggest": true, "x-since-version": "v1.2.0" } }, @@ -10032,6 +10102,7 @@ "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" }, @@ -10122,13 +10193,29 @@ ] }, "vectorsearch.IndexSubtype": { - "type": "string" + "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" + ] }, "vectorsearch.PipelineType": { - "type": "string" + "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" + ] }, "vectorsearch.VectorIndexType": { - "type": "string" + "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" + ] }, "workspace.AzureKeyVaultSecretScopeMetadata": { "type": "object", @@ -10224,6 +10311,12 @@ "$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": { From ae99f5235d901caec5046d9ddf2eef7e305b07b9 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 17 Jun 2026 11:59:23 +0000 Subject: [PATCH 09/31] Update jsonschema_for_docs.json for v1.4.0 --- bundle/schema/jsonschema_for_docs.json | 1609 ++++++++++++++++-------- 1 file changed, 1109 insertions(+), 500 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 7a18f1aeb8e..65218a69e7a 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -22,18 +22,22 @@ "type": "object", "properties": { "custom_description": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "custom_summary": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "display_name": { + "description": "[Public Preview]", "$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" }, @@ -46,6 +50,7 @@ "x-since-version": "v0.279.0" }, "parent_path": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, @@ -54,24 +59,29 @@ "x-since-version": "v0.279.0" }, "query_text": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "run_as": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs", "x-since-version": "v0.279.0" }, "run_as_user_name": { + "description": "[Public Preview]", "$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]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -89,18 +99,21 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.243.0" }, "compute_max_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, "compute_min_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, @@ -125,8 +138,6 @@ "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-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.290.0" }, "lifecycle": { @@ -150,26 +161,27 @@ }, "source_code_path": { "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.239.0" }, "space": { - "description": "Name of the space this app belongs to.", + "description": "[Private Preview] Name of the space this app belongs to.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "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" } @@ -588,16 +600,17 @@ "type": "object", "properties": { "create_database_if_not_exists": { + "description": "[Public Preview]", "$ref": "#/$defs/bool", "x-since-version": "v0.265.0" }, "database_instance_name": { - "description": "The name of the DatabaseInstance housing the database.", + "description": "[Public Preview] The name of the DatabaseInstance housing the database.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" }, "database_name": { - "description": "The name of the database (in a instance) associated with the catalog.", + "description": "[Public Preview] The name of the database (in a instance) associated with the catalog.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" }, @@ -607,7 +620,7 @@ "x-since-version": "v0.268.0" }, "name": { - "description": "The name of the catalog in UC.", + "description": "[Public Preview] The name of the catalog in UC.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" } @@ -624,22 +637,22 @@ "description": "A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.", "properties": { "capacity": { - "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "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": "Custom tags associated with the instance. This field is only included on create and update responses.", + "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": "Whether to enable PG native password login on the instance. Defaults to false.", + "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": "Whether to enable secondaries to serve read-only traffic. Defaults to false.", + "description": "[Public Preview] Whether to enable secondaries to serve read-only traffic. Defaults to false.", "$ref": "#/$defs/bool", "x-since-version": "v0.265.0" }, @@ -649,17 +662,17 @@ "x-since-version": "v0.268.0" }, "name": { - "description": "The name of the instance. This is the unique identifier for the instance.", + "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": "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.", + "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": "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.", + "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" }, @@ -668,17 +681,17 @@ "x-since-version": "v0.265.0" }, "retention_window_in_days": { - "description": "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.", + "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": "Whether to stop the instance. An input only param, see effective_stopped for the output.", + "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": "The desired usage policy to associate with the instance.", + "description": "[Beta] The desired usage policy to associate with the instance.", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" } @@ -799,7 +812,7 @@ "type": "object", "properties": { "budget_policy_id": { - "description": "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.", + "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" }, @@ -906,9 +919,9 @@ "x-since-version": "v0.229.0" }, "usage_policy_id": { - "description": "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.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.265.0" }, @@ -1219,7 +1232,7 @@ "x-since-version": "v0.261.0" }, "budget_policy_id": { - "description": "Budget policy of this pipeline.", + "description": "[Public Preview] Budget policy of this pipeline.", "$ref": "#/$defs/string", "x-since-version": "v0.230.0" }, @@ -1259,7 +1272,7 @@ "x-since-version": "v0.229.0" }, "environment": { - "description": "Environment specification for this pipeline used to install dependencies.", + "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" }, @@ -1274,9 +1287,9 @@ "x-since-version": "v0.229.0" }, "gateway_definition": { - "description": "The definition of a gateway pipeline to support change data capture.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -1286,7 +1299,7 @@ "x-since-version": "v0.229.0" }, "ingestion_definition": { - "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "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" }, @@ -1311,6 +1324,7 @@ "x-since-version": "v0.229.0" }, "parameters": { + "description": "[Beta]", "$ref": "#/$defs/map/string", "x-since-version": "v1.2.0" }, @@ -1324,14 +1338,14 @@ "x-since-version": "v0.229.0" }, "restart_window": { - "description": "Restart window of this pipeline.", + "description": "[Private Preview] Restart window of this pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.234.0" }, "root_path": { - "description": "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.", + "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" }, @@ -1374,9 +1388,9 @@ "deprecated": true }, "usage_policy_id": { - "description": "Usage policy of this pipeline.", + "description": "[Private Preview] Usage policy of this pipeline.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.276.0" } @@ -1493,6 +1507,36 @@ "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": { @@ -1609,6 +1653,55 @@ "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": { @@ -1681,9 +1774,9 @@ "x-since-version": "v0.229.0" }, "data_classification_config": { - "description": "[Create:OPT Update:OPT] Data classification related 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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -2056,6 +2149,7 @@ "type": "object", "properties": { "database_instance_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, @@ -2064,14 +2158,17 @@ "x-since-version": "v0.268.0" }, "logical_database_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "spec": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec", "x-since-version": "v0.266.0" } @@ -2085,6 +2182,7 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.298.0" }, @@ -2105,12 +2203,14 @@ "x-since-version": "v0.298.0" }, "target_qps": { + "description": "[Public Preview]", "$ref": "#/$defs/int64", "x-since-version": "v0.299.2" }, "usage_policy_id": { + "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -2141,6 +2241,7 @@ "x-since-version": "v1.1.0" }, "index_subtype": { + "description": "[Beta]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype", "x-since-version": "v1.1.0" }, @@ -2712,6 +2813,10 @@ "$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" @@ -2720,6 +2825,10 @@ "$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", @@ -3443,8 +3552,7 @@ "type": "string", "enum": [ "MEDIUM", - "LARGE", - "LIQUID" + "LARGE" ] }, "apps.ComputeState": { @@ -3732,8 +3840,10 @@ "description": "Data classification related configuration.", "properties": { "enabled": { - "description": "Whether to enable data classification.", + "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" } }, @@ -3862,9 +3972,9 @@ "x-since-version": "v0.229.0" }, "on_new_classification_tag_detected": { - "description": "Destinations to send notifications 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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" } @@ -3949,26 +4059,7 @@ "CREATE_CLEAN_ROOM", "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", - "EXTERNAL_USE_SCHEMA", - "VIEW_OBJECT", - "MANAGE_GRANTS", - "INSERT", - "UPDATE", - "DELETE", - "VIEW_ADMIN_METADATA", - "VIEW_METADATA", - "USE_VOLUME", - "READ_METADATA", - "MANAGE_ACCESS", - "MANAGE_ACCESS_CONTROL", - "CREATE_SERVICE", - "CREATE_FEATURE", - "READ_FEATURE", - "CREATE_STREAM", - "READ_STREAM", - "CREATE_MEMORY_STORE", - "READ_MEMORY_STORE", - "WRITE_MEMORY_STORE" + "EXTERNAL_USE_SCHEMA" ] }, "catalog.PrivilegeAssignment": { @@ -4406,6 +4497,10 @@ "enum": [ "CONFIDENTIAL_COMPUTE_TYPE_NONE", "SEV_SNP" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, "compute.DataSecurityMode": { @@ -4422,6 +4517,18 @@ "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": { @@ -4505,6 +4612,7 @@ "x-since-version": "v0.252.0" }, "java_dependencies": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/string", "x-since-version": "v0.271.0" } @@ -4525,9 +4633,9 @@ "x-since-version": "v0.229.0" }, "confidential_compute_type": { - "description": "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.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, @@ -4590,8 +4698,11 @@ "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", - "GPU_1xH100" + "GPU_8xH100" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "compute.InitScriptInfo": { @@ -4640,6 +4751,7 @@ }, "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" ] @@ -4900,12 +5012,12 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", + "description": "[Public Preview] The key of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "value": { - "description": "The value of the custom tag.", + "description": "[Public Preview] The value of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" } @@ -4917,17 +5029,17 @@ "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": "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.", + "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": "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.", + "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": "Name of the ref database instance.", + "description": "[Public Preview] Name of the ref database instance.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" } @@ -4942,8 +5054,15 @@ "DELETING", "STOPPED", "UPDATING", - "FAILING_OVER", - "UPGRADING" + "FAILING_OVER" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "database.DeltaTableSyncInfo": { @@ -4955,17 +5074,17 @@ "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": "Budget policy to set on the newly created pipeline.", + "description": "[Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "storage_catalog": { - "description": "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.", + "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": "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.", + "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" } @@ -4981,6 +5100,14 @@ "DELETING", "UPDATING", "DEGRADED" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "database.ProvisioningPhase": { @@ -4989,6 +5116,11 @@ "PROVISIONING_PHASE_MAIN", "PROVISIONING_PHASE_INDEX_SCAN", "PROVISIONING_PHASE_INDEX_SORT" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "database.SyncedTableContinuousUpdateStatus": { @@ -5021,6 +5153,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "database.SyncedTableSpec": { @@ -5028,37 +5165,37 @@ "description": "Specification of a synced database table.", "properties": { "create_database_objects_if_missing": { - "description": "If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.", + "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": "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.", + "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": "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.", + "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": "Primary Key columns to be used for data insert/update in the destination.", + "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": "Scheduling policy of the underlying pipeline.", + "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": "Three-part (catalog, schema, table) name of the source Delta table.", + "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": "Time series key to deduplicate (tie-break) rows with the same primary 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" } @@ -5080,6 +5217,19 @@ "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": { @@ -5087,22 +5237,22 @@ "description": "Status of a synced table.", "properties": { "continuous_update_status": { - "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.", + "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": "Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", + "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": "Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", + "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": "Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE\nor the SYNCED_NO_PENDING_UPDATE state.", + "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" } @@ -5137,30 +5287,51 @@ "CAN_MONITOR", "CAN_CREATE", "CAN_MONITOR_ONLY", - "CAN_CREATE_APP", - "UNSPECIFIED" + "CAN_CREATE_APP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "[Private Preview]", + "[Private Preview]" ] }, "jobs.AlertTask": { "type": "object", "properties": { "alert_id": { - "description": "The alert_id is the canonical identifier of the alert.", + "description": "[Public Preview] The alert_id is the canonical identifier of the alert.", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" }, "subscribers": { - "description": "The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", + "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": "The warehouse_id identifies the warehouse settings used by the alert task.", + "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": "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.", + "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" } @@ -5172,11 +5343,12 @@ "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": "A valid workspace email address.", + "description": "[Public Preview] A valid workspace email address.", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" } @@ -5188,6 +5360,10 @@ "enum": [ "OAUTH", "PAT" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, "jobs.CleanRoomsNotebookTask": { @@ -5225,7 +5401,7 @@ "type": "object", "properties": { "hardware_accelerator": { - "description": "Hardware accelerator configuration for Serverless GPU workloads.", + "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" } @@ -5236,18 +5412,24 @@ "type": "object", "properties": { "gpu_node_pool_id": { - "description": "IDof the GPU pool to use.", + "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": "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": "Number of GPUs.", + "description": "[Private Preview] Number of GPUs.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" } }, @@ -5351,9 +5533,9 @@ "x-since-version": "v0.248.0" }, "filters": { - "description": "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\\\"}\"`)", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.289.0" }, @@ -5374,13 +5556,17 @@ "description": "Deprecated in favor of DbtPlatformTask", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt Cloud for this task", + "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": "Id of the dbt Cloud job to be triggered", + "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" } }, @@ -5390,13 +5576,17 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt platform for this task", + "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": "Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", + "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" } }, @@ -5506,42 +5696,59 @@ "type": "object", "properties": { "command": { - "description": "Command launcher to run the actual script, e.g. bash, python etc.", + "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": "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": "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.", + "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": "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.", + "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": "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.", + "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": "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.", + "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": "Optional path to a YAML file containing model parameters passed to the training script.", + "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" } }, @@ -5638,13 +5845,6 @@ "jobs.JobDeployment": { "type": "object", "properties": { - "deployment_id": { - "description": "ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", - "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, - "x-since-version": "v1.2.0" - }, "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", @@ -5654,13 +5854,6 @@ "description": "Path of the file that contains deployment metadata.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" - }, - "version_id": { - "description": "ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", - "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, - "x-since-version": "v1.2.0" } }, "additionalProperties": false, @@ -5674,6 +5867,10 @@ "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": { @@ -5682,6 +5879,10 @@ "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": { @@ -5710,7 +5911,7 @@ "x-since-version": "v0.229.0" }, "on_streaming_backlog_exceeded": { - "description": "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.", + "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" }, @@ -5791,9 +5992,9 @@ "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": "Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.283.0" }, @@ -5815,18 +6016,24 @@ "description": "The source of the job specification in the remote repository when the job is source controlled.", "properties": { "dirty_state": { - "description": "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.", + "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": "Name of the branch which the job is imported from.", + "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": "Path of the job YAML file that contains the job specification.", + "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" } }, @@ -5842,6 +6049,10 @@ "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": { @@ -5853,6 +6064,13 @@ "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": { @@ -5901,28 +6119,38 @@ "type": "object", "properties": { "aliases": { - "description": "Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", + "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": "The condition based on which to trigger a job run.", + "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": "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.", + "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": "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.", + "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": "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.", + "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" } }, @@ -5937,6 +6165,11 @@ "MODEL_CREATED", "MODEL_VERSION_READY", "MODEL_ALIAS_SET" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "jobs.NotebookTask": { @@ -6020,22 +6253,22 @@ "x-since-version": "v0.229.0" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", + "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "refresh_flow_selection": { - "description": "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.", + "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": "A list of tables to update without fullRefresh.", + "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" } @@ -6051,12 +6284,12 @@ "x-since-version": "v0.229.0" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", + "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "parameters": { - "description": "Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", + "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" }, @@ -6066,17 +6299,17 @@ "x-since-version": "v0.229.0" }, "refresh_flow_selection": { - "description": "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.", + "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": "A list of tables to update without fullRefresh.", + "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" } @@ -6090,27 +6323,27 @@ "type": "object", "properties": { "authentication_method": { - "description": "How the published Power BI model authenticates to Databricks", + "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": "The name of the Power BI model", + "description": "[Public Preview] The name of the Power BI model", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "overwrite_existing": { - "description": "Whether to overwrite existing Power BI models", + "description": "[Public Preview] Whether to overwrite existing Power BI models", "$ref": "#/$defs/bool", "x-since-version": "v0.248.0" }, "storage_mode": { - "description": "The default storage mode of the Power BI model", + "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": "The name of the Power BI workspace of the model", + "description": "[Public Preview] The name of the Power BI workspace of the model", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" } @@ -6121,22 +6354,22 @@ "type": "object", "properties": { "catalog": { - "description": "The catalog name in Databricks", + "description": "[Public Preview] The catalog name in Databricks", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "name": { - "description": "The table name in Databricks", + "description": "[Public Preview] The table name in Databricks", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "schema": { - "description": "The schema name in Databricks", + "description": "[Public Preview] The schema name in Databricks", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "storage_mode": { - "description": "The Power BI storage mode of the table", + "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" } @@ -6147,27 +6380,27 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection to authenticate from Databricks to Power BI", + "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": "The semantic model to update", + "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": "Whether the model should be refreshed after the update", + "description": "[Public Preview] Whether the model should be refreshed after the update", "$ref": "#/$defs/bool", "x-since-version": "v0.248.0" }, "tables": { - "description": "The tables to be exported to Power BI", + "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": "The SQL warehouse ID to use as the Power BI data source", + "description": "[Public Preview] The SQL warehouse ID to use as the Power BI data source", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" } @@ -6178,13 +6411,17 @@ "type": "object", "properties": { "main": { - "description": "Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", + "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": "An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for 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" } }, @@ -6194,11 +6431,17 @@ "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" } }, @@ -6258,24 +6501,32 @@ "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": "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.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", "deprecated": true }, "jar_params": { - "description": "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.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6292,9 +6543,9 @@ "x-since-version": "v0.229.0" }, "notebook_params": { - "description": "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.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6306,35 +6557,36 @@ "x-since-version": "v0.229.0" }, "python_named_params": { + "description": "[Private Preview]", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", "deprecated": true }, "python_params": { - "description": "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.", + "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-preview": "PRIVATE", + "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": "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.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", "deprecated": true }, "sql_params": { - "description": "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.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6352,6 +6604,10 @@ "enum": [ "WORKSPACE", "GIT" + ], + "enumDescriptions": [ + "SQL file is located in \u003cDatabricks\u003e workspace.", + "SQL file is located in cloud Git provider." ] }, "jobs.SparkJarTask": { @@ -6577,6 +6833,11 @@ "DIRECT_QUERY", "IMPORT", "DUAL" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "jobs.Subscription": { @@ -6646,7 +6907,7 @@ "type": "object", "properties": { "alert_task": { - "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", + "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" }, @@ -6656,7 +6917,7 @@ "x-since-version": "v0.237.0" }, "compute": { - "description": "Task level compute configuration.", + "description": "[Beta] Task level compute configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", "x-since-version": "v0.288.0" }, @@ -6671,17 +6932,18 @@ "x-since-version": "v0.248.0" }, "dbt_cloud_task": { - "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_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-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.257.0" }, @@ -6731,8 +6993,9 @@ "x-since-version": "v0.229.0" }, "gen_ai_compute_task": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, @@ -6781,14 +7044,14 @@ "x-since-version": "v0.229.0" }, "power_bi_task": { - "description": "The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", + "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": "The task runs a 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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, @@ -6900,7 +7163,7 @@ "x-since-version": "v0.229.0" }, "on_streaming_backlog_exceeded": { - "description": "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.", + "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" }, @@ -6950,8 +7213,9 @@ "x-since-version": "v0.229.0" }, "model": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, @@ -7004,7 +7268,7 @@ "x-since-version": "v0.229.0" }, "on_streaming_backlog_exceeded": { - "description": "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.", + "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" }, @@ -7075,12 +7339,12 @@ "description": "Policy for auto full refresh.", "properties": { "enabled": { - "description": "(Required, Mutable) Whether to enable auto full refresh or not.", + "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": "(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.", + "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" } @@ -7095,7 +7359,7 @@ "description": "Confluence specific options for ingestion", "properties": { "include_confluence_spaces": { - "description": "(Optional) Spaces to filter Confluence data on", + "description": "[Public Preview] (Optional) Spaces to filter Confluence data on", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" } @@ -7106,9 +7370,9 @@ "type": "object", "properties": { "source_catalog": { - "description": "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.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" } @@ -7120,70 +7384,73 @@ "description": "Wrapper message for source-specific options to support multiple connector types", "properties": { "confluence_options": { - "description": "Confluence specific options for ingestion", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "google_ads_options": { - "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "jira_options": { - "description": "Jira specific options for ingestion", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "meta_ads_options": { - "description": "Meta Marketing (Meta Ads) specific options for ingestion", + "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": "Outlook specific options for ingestion", + "description": "[Private Preview] Outlook specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", - "x-databricks-preview": "PRIVATE", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "smartsheet_options": { - "description": "Smartsheet specific options for ingestion", + "description": "[Private Preview] Smartsheet specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "tiktok_ads_options": { - "description": "TikTok Ads specific options for ingestion", + "description": "[Private Preview] TikTok Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "zendesk_support_options": { - "description": "Zendesk Support specific options for ingestion", + "description": "[Private Preview] Zendesk Support specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -7196,6 +7463,10 @@ "enum": [ "CDC", "QUERY_BASED" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "pipelines.CronTrigger": { @@ -7217,17 +7488,17 @@ "description": "Location of staged data storage", "properties": { "catalog_name": { - "description": "(Required, Immutable) The name of the catalog for the connector's staging storage location.", + "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": "(Required, Immutable) The name of the schema for the connector's staging storage location.", + "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": "(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", + "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" } @@ -7249,6 +7520,15 @@ "FRIDAY", "SATURDAY", "SUNDAY" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "pipelines.DeploymentKind": { @@ -7284,18 +7564,24 @@ "type": "object", "properties": { "modified_after": { - "description": "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", + "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": "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", + "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": "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", + "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" } }, @@ -7305,53 +7591,80 @@ "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": "Generic options", + "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": "required for TableSpec", + "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": "Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-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": "Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", + "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": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", + "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": "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", + "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" } }, @@ -7367,8 +7680,17 @@ "EXCEL", "PARQUET", "AVRO", - "ORC", - "FILE" + "ORC" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.FileIngestionOptionsSchemaEvolutionMode": { @@ -7380,6 +7702,13 @@ "RESCUE", "FAIL_ON_NEW_COLUMNS", "NONE" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.FileLibrary": { @@ -7413,8 +7742,10 @@ "type": "object", "properties": { "manager_account_id": { - "description": "(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.", + "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" } }, @@ -7425,18 +7756,24 @@ "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": "(Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 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": "(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.", + "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": "(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.", + "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" } }, @@ -7449,16 +7786,24 @@ "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": "Google Drive URL.", + "description": "[Private Preview] Google Drive URL.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -7469,26 +7814,29 @@ "enum": [ "FILE", "FILE_METADATA", - "PERMISSION", - "FILE_PERMISSION", - "GROUP_MEMBERSHIP" + "PERMISSION" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.IngestionConfig": { "type": "object", "properties": { "report": { - "description": "Select a specific source 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": "Select all tables from a specific source 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": "Select a specific source 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" } @@ -7499,37 +7847,47 @@ "type": "object", "properties": { "connection_id": { - "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "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": "Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "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": "Optional, Internal. Parameters required to establish an initial connection with the source.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "gateway_storage_catalog": { - "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", + "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": "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.", + "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": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.", + "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" } }, @@ -7544,53 +7902,54 @@ "type": "object", "properties": { "connection_name": { - "description": "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.", + "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": "(Optional) Connector Type for sources. Ex: CDC, Query Based.", + "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": "(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.", + "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": "(Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", + "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": "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.", + "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": "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.", + "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]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" }, "objects": { - "description": "Required. Settings specifying tables to replicate and the destination for the replicated tables.", + "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": "Top-level 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": "Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.", + "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" } @@ -7602,17 +7961,17 @@ "description": "Configurations that are only applicable for query-based ingestion connectors.", "properties": { "cursor_columns": { - "description": "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.", + "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": "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.", + "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": "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.", + "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" } @@ -7623,21 +7982,27 @@ "type": "object", "properties": { "incremental": { - "description": "(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.", + "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": "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}", + "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": "(Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", + "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 } @@ -7648,13 +8013,17 @@ "type": "object", "properties": { "key": { - "description": "Key for the report parameter, can be a column name or other metadata", + "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": "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", + "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" } }, @@ -7665,8 +8034,6 @@ "enum": [ "MYSQL", "POSTGRESQL", - "REDSHIFT", - "SQLDW", "SQLSERVER", "SALESFORCE", "BIGQUERY", @@ -7683,87 +8050,30 @@ "JIRA", "CONFLUENCE", "META_MARKETING", - "GOOGLE_ADS", - "TIKTOK_ADS", - "SALESFORCE_MARKETING_CLOUD", - "HUBSPOT", - "WORKDAY_HCM", - "GUIDEWIRE", "ZENDESK", - "COMMUNITY", - "SLACK_AUDIT_LOGS", - "KAFKA", - "CROWDSTRIKE_EVENT_STREAM", - "WORKDAY_ACTIVITY_LOGGING", - "AKAMAI_WAF", - "VEEVA", - "VEEVA_VAULT", - "M365_AUDIT_LOGS", - "OKTA_SYSTEM_LOGS", - "ONE_PASSWORD_EVENT_LOGS", - "PROOFPOINT_SIEM", - "WIZ_AUDIT_LOGS", - "GITHUB", - "OUTLOOK", - "SMARTSHEET", - "MICROSOFT_TEAMS", - "ADOBE_CAMPAIGNS", - "LINKEDIN_ADS", - "X_ADS", - "BING_ADS", - "GOOGLE_SEARCH_CONSOLE", - "PINTEREST_ADS", - "REDDIT_ADS", - "PENDO", - "API_SOURCE", - "SLACK_ACCESS_AND_INTEGRATION_LOGS", - "ORACLE_FUSION_CLOUD", - "RABBITMQ", - "GOOGLE_ANALYTICS", - "AMPLITUDE", - "NOTION", - "ADP_WORKFORCE_NOW", - "SAS", - "GONG", - "SALESLOFT", - "GOOGLE_WORKSPACE", - "SHOPIFY", - "ORACLE_ELOQUA", - "EPIC_CLARITY", - "LINEAR", - "APPLE_APP_STORE", - "SPLUNK", - "GITLAB", - "ZOOM_LOGS", - "MONDAY_COM", - "AIRTABLE", - "MICROSOFT_ENTRA_ID", - "PAGERDUTY", - "APPFIGURES", - "ADOBE_COMMERCE", - "QUICKBOOKS", - "SQUARE", - "ZOHO_BOOKS", - "SNAPCHAT_ADS", - "GENESYS", - "SAP_SUCCESSFACTORS", - "YOUTUBE_ANALYTICS", - "CERIDIAN_DAYFORCE", - "FRESHSERVICE", - "SENDGRID", - "AZURE_MONITOR_LOGS", - "ATLASSIAN_ORGANIZATION", - "HIBOB", - "APPLE_SEARCH_ADS", - "AWIN", - "DELIGHTED", - "FRONT", - "GURU", - "PARTNERSTACK", - "MARKETO", - "AHA", - "NETSKOPE_LOGS", "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": { @@ -7771,7 +8081,7 @@ "description": "Jira specific options for ingestion", "properties": { "include_jira_spaces": { - "description": "(Optional) Projects to filter Jira data on", + "description": "[Beta] (Optional) Projects to filter Jira data on", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" } @@ -7782,28 +8092,38 @@ "type": "object", "properties": { "as_variant": { - "description": "Parse the entire value as a single Variant column.", + "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": "Inline schema string for JSON parsing (Spark DDL format).", + "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": "(Optional) Schema evolution mode for schema inference.", + "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": "Path to a schema file (.ddl).", + "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": "(Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", + "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" } }, @@ -7813,42 +8133,52 @@ "type": "object", "properties": { "client_config": { - "description": "Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "key_transformer": { - "description": "(Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", + "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": "Internal option to control the maximum number of offsets to process per trigger.", + "description": "[Private Preview] Internal option to control the maximum number of offsets to process per trigger.", "$ref": "#/$defs/int64", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "starting_offset": { - "description": "(Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", + "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": "Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", + "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": "Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", + "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": "(Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", + "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" } }, @@ -7863,42 +8193,42 @@ "description": "Meta Marketing (Meta Ads) specific options for ingestion", "properties": { "action_attribution_windows": { - "description": "(Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", + "description": "[Beta] (Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" }, "action_breakdowns": { - "description": "(Optional) Action breakdowns to configure for data aggregation", + "description": "[Beta] (Optional) Action breakdowns to configure for data aggregation", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" }, "action_report_time": { - "description": "(Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", + "description": "[Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", "$ref": "#/$defs/string", "x-since-version": "v0.299.2" }, "breakdowns": { - "description": "(Optional) Breakdowns to configure for data aggregation", + "description": "[Beta] (Optional) Breakdowns to configure for data aggregation", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" }, "custom_insights_lookback_window": { - "description": "(Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", + "description": "[Beta] (Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", "$ref": "#/$defs/int", "x-since-version": "v0.299.2" }, "level": { - "description": "(Optional) Granularity of data to pull (account, ad, adset, campaign)", + "description": "[Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign)", "$ref": "#/$defs/string", "x-since-version": "v0.299.2" }, "start_date": { - "description": "(Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested", + "description": "[Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested", "$ref": "#/$defs/string", "x-since-version": "v0.299.2" }, "time_increment": { - "description": "(Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", + "description": "[Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", "$ref": "#/$defs/string", "x-since-version": "v0.299.2" } @@ -7937,17 +8267,17 @@ "description": "Proto representing a window", "properties": { "days_of_week": { - "description": "Days of week in which the window is allowed to happen\nIf not specified all days of the week will be used.", + "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": "An integer between 0 and 23 denoting the start hour for the window in the 24-hour day.", + "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": "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.", + "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" } @@ -7965,6 +8295,12 @@ "NON_INLINE_ONLY", "INLINE_ONLY", "NONE" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.OutlookBodyFormat": { @@ -7973,6 +8309,10 @@ "enum": [ "TEXT_HTML", "TEXT_PLAIN" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.OutlookOptions": { @@ -7980,58 +8320,78 @@ "description": "Outlook specific options for ingestion", "properties": { "attachment_mode": { - "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", + "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": "(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.", + "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": "Deprecated. Use include_folders instead.", + "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": "(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.", + "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": "(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.", + "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": "(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.", + "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": "(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.", + "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": "Deprecated. Use include_senders instead.", + "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": "(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.", + "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": "Deprecated. Use include_subjects instead.", + "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 } @@ -8042,7 +8402,7 @@ "type": "object", "properties": { "include": { - "description": "The source code to include for pipelines", + "description": "[Public Preview] The source code to include for pipelines", "$ref": "#/$defs/string", "x-since-version": "v0.252.0" } @@ -8186,13 +8546,6 @@ "pipelines.PipelineDeployment": { "type": "object", "properties": { - "deployment_id": { - "description": "ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", - "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, - "x-since-version": "v1.2.0" - }, "kind": { "description": "The deployment method that manages the pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind", @@ -8202,13 +8555,6 @@ "description": "The path to the file containing metadata about the deployment.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" - }, - "version_id": { - "description": "ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", - "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, - "x-since-version": "v1.2.0" } }, "additionalProperties": false, @@ -8225,21 +8571,21 @@ "x-since-version": "v0.229.0" }, "glob": { - "description": "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`.", + "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": "URI of the jar to be installed. Currently only DBFS is supported.", + "description": "[Private Preview] URI of the jar to be installed. Currently only DBFS is supported.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "maven": { - "description": "Specification of a maven library to be installed.", + "description": "[Private Preview] Specification of a maven library to be installed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -8287,14 +8633,14 @@ "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": "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", + "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": "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\"`.", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.294.0" } @@ -8306,7 +8652,7 @@ "description": "PG-specific catalog-level configuration parameters", "properties": { "slot_config": { - "description": "Optional. The Postgres slot configuration to use for logical replication", + "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" } @@ -8318,12 +8664,12 @@ "description": "PostgresSlotConfig contains the configuration for a Postgres logical replication slot", "properties": { "publication_name": { - "description": "The name of the publication to use for the Postgres source", + "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": "The name of the logical replication slot to use for the Postgres source", + "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" } @@ -8334,27 +8680,27 @@ "type": "object", "properties": { "destination_catalog": { - "description": "Required. Destination catalog to store table.", + "description": "[Public Preview] Required. Destination catalog to store table.", "$ref": "#/$defs/string", "x-since-version": "v0.231.0" }, "destination_schema": { - "description": "Required. Destination schema to store table.", + "description": "[Public Preview] Required. Destination schema to store table.", "$ref": "#/$defs/string", "x-since-version": "v0.231.0" }, "destination_table": { - "description": "Required. Destination table name. The pipeline fails if a table with that name already exists.", + "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": "Required. Report URL in the source system.", + "description": "[Public Preview] Required. Report URL in the source system.", "$ref": "#/$defs/string", "x-since-version": "v0.231.0" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object.", + "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" } @@ -8370,18 +8716,24 @@ "type": "object", "properties": { "days_of_week": { - "description": "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.", + "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": "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.", + "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": "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.", + "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" } }, @@ -8411,32 +8763,32 @@ "type": "object", "properties": { "connector_options": { - "description": "(Optional) Source Specific 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": "Required. Destination catalog to store tables.", + "description": "[Public Preview] Required. Destination catalog to store tables.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "destination_schema": { - "description": "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.", + "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": "The source catalog name. Might be optional depending on the type of source.", + "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": "Required. Schema name in the source database.", + "description": "[Public Preview] Required. Schema name in the source database.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "table_configuration": { - "description": "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.", + "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" } @@ -8452,18 +8804,24 @@ "type": "object", "properties": { "entity_type": { - "description": "(Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", + "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": "(Optional) File ingestion options for processing files.", + "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": "Required. The SharePoint 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" } }, @@ -8475,9 +8833,13 @@ "FILE", "FILE_METADATA", "PERMISSION", - "LIST", - "FILE_PERMISSION", - "GROUP_MEMBERSHIP" + "LIST" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.SmartsheetOptions": { @@ -8485,8 +8847,10 @@ "description": "Smartsheet specific options for ingestion", "properties": { "enforce_schema": { - "description": "(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.", + "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" } }, @@ -8497,12 +8861,12 @@ "description": "SourceCatalogConfig contains catalog-level custom configuration parameters for each source", "properties": { "postgres": { - "description": "Postgres-specific catalog-level configuration parameters", + "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": "Source catalog name", + "description": "[Public Preview] Source catalog name", "$ref": "#/$defs/string", "x-since-version": "v0.267.0" } @@ -8513,13 +8877,14 @@ "type": "object", "properties": { "catalog": { - "description": "Catalog-level source configuration parameters", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -8530,42 +8895,42 @@ "type": "object", "properties": { "connector_options": { - "description": "(Optional) Source Specific 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": "Required. Destination catalog to store table.", + "description": "[Public Preview] Required. Destination catalog to store table.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "destination_schema": { - "description": "Required. Destination schema to store table.", + "description": "[Public Preview] Required. Destination schema to store table.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "destination_table": { - "description": "Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used.", + "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": "Source catalog name. Might be optional depending on the type of source.", + "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": "Schema name in the source database. Might be optional depending on the type of source.", + "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": "Required. Table name in the source database.", + "description": "[Public Preview] Required. Table name in the source database.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec.", + "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" } @@ -8581,55 +8946,56 @@ "type": "object", "properties": { "auto_full_refresh_policy": { - "description": "(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.", + "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" }, "exclude_columns": { - "description": "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`.", + "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": "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`.", + "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": "The primary key of the table used to apply changes.", + "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": "Configurations that are only applicable for query-based ingestion connectors.", + "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": "(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.", + "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": "If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", + "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-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "scd_type": { - "description": "The SCD type to use to ingest the table.", + "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": "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.", + "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" }, "workday_report_parameters": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" } @@ -8643,6 +9009,11 @@ "SCD_TYPE_1", "SCD_TYPE_2", "APPEND_ONLY" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "pipelines.TikTokAdsOptions": { @@ -8650,38 +9021,52 @@ "description": "TikTok Ads specific options for ingestion", "properties": { "data_level": { - "description": "(Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "dimensions": { - "description": "(Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", + "description": "[Private Preview] (Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 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.\nIf not specified, defaults to 7 days.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "metrics": { - "description": "(Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", + "description": "[Private Preview] (Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "query_lifetime": { - "description": "(Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", + "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "report_type": { - "description": "(Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", + "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "sync_start_date": { - "description": "(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 1 year of historical data for daily reports\nand 30 days for hourly reports.", + "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 1 year of historical data for daily reports\nand 30 days for hourly reports.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -8695,6 +9080,12 @@ "AUCTION_CAMPAIGN", "AUCTION_ADGROUP", "AUCTION_AD" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.TikTokAdsOptionsTikTokReportType": { @@ -8707,6 +9098,14 @@ "DSA", "BUSINESS_CENTER", "GMV_MAX" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.Transformer": { @@ -8714,12 +9113,17 @@ "description": "Specifies how to transform binary data into structured data.", "properties": { "format": { - "description": "Required: the wire format of the data.", + "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" } }, @@ -8729,9 +9133,11 @@ "type": "string", "enum": [ "STRING", - "JSON", - "AVRO", - "PROTOBUF" + "JSON" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.ZendeskSupportOptions": { @@ -8739,8 +9145,10 @@ "description": "Zendesk Support specific options for ingestion", "properties": { "start_date": { - "description": "(Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", + "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" } }, @@ -8750,17 +9158,17 @@ "type": "object", "properties": { "enable_readable_secondaries": { - "description": "Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1.", + "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": "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.", + "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": "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.", + "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" } @@ -8776,7 +9184,7 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "pg_settings": { - "description": "A raw representation of Postgres settings.", + "description": "[Beta] A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", "x-since-version": "v0.287.0" } @@ -8789,23 +9197,27 @@ "enum": [ "ENDPOINT_TYPE_READ_WRITE", "ENDPOINT_TYPE_READ_ONLY" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "postgres.NewPipelineSpec": { "type": "object", "properties": { "budget_policy_id": { - "description": "Budget policy to set on the newly created pipeline.", + "description": "[Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "storage_catalog": { - "description": "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.", + "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": "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.", + "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" } @@ -8816,12 +9228,12 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", + "description": "[Beta] The key of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.290.0" }, "value": { - "description": "The value of the custom tag.", + "description": "[Beta] The value of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.290.0" } @@ -8833,33 +9245,93 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "autoscaling_limit_max_cu": { - "description": "The maximum number of Compute Units. Minimum value is 0.5.", + "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": "The minimum number of Compute Units. Minimum value is 0.5.", + "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": "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.", + "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": "A raw representation of Postgres settings.", + "description": "[Beta] A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", "x-since-version": "v0.287.0" }, "suspend_timeout_duration": { - "description": "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.", + "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.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy": { "type": "string", "description": "Scheduling policy of the synced table's underlying pipeline.", @@ -8867,6 +9339,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]", + "[Beta]" ] }, "serving.Ai21LabsConfig": { @@ -8894,7 +9371,7 @@ "x-since-version": "v0.246.0" }, "guardrails": { - "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", + "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" }, @@ -8920,24 +9397,24 @@ "type": "object", "properties": { "invalid_keywords": { - "description": "List of invalid keywords.\nAI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.", + "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": "Configuration for guardrail PII filter.", + "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": "Indicates whether the safety filter is enabled.", + "description": "[Public Preview] Indicates whether the safety filter is enabled.", "$ref": "#/$defs/bool", "x-since-version": "v0.230.0" }, "valid_topics": { - "description": "The list of allowed topics.\nGiven a chat request, this guardrail flags the request if its topic is not in the allowed 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", @@ -8950,7 +9427,7 @@ "type": "object", "properties": { "behavior": { - "description": "Configuration for input guardrail filters.", + "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" } @@ -8963,18 +9440,23 @@ "NONE", "BLOCK", "MASK" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "serving.AiGatewayGuardrails": { "type": "object", "properties": { "input": { - "description": "Configuration for input guardrail filters.", + "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": "Configuration for output guardrail filters.", + "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" } @@ -9048,12 +9530,21 @@ "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": { @@ -9119,6 +9610,12 @@ "cohere", "ai21labs", "amazon" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "serving.AnthropicConfig": { @@ -9420,6 +9917,17 @@ "openai", "palm", "custom" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "serving.FallbackConfig": { @@ -9574,12 +10082,19 @@ "enum": [ "user", "endpoint" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, "serving.RateLimitRenewalPeriod": { "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[Public Preview]" ] }, "serving.Route": { @@ -9609,7 +10124,7 @@ "type": "object", "properties": { "burst_scaling_enabled": { - "description": "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.", + "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" }, @@ -9633,7 +10148,7 @@ "x-since-version": "v0.229.0" }, "instance_profile_arn": { - "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "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" }, @@ -9663,7 +10178,7 @@ "x-since-version": "v0.229.0" }, "provisioned_model_units": { - "description": "The number of model units provisioned.", + "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", "x-since-version": "v0.252.0" }, @@ -9689,7 +10204,7 @@ "type": "object", "properties": { "burst_scaling_enabled": { - "description": "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.", + "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" }, @@ -9699,7 +10214,7 @@ "x-since-version": "v0.229.0" }, "instance_profile_arn": { - "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "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" }, @@ -9737,7 +10252,7 @@ "x-since-version": "v0.229.0" }, "provisioned_model_units": { - "description": "The number of model units provisioned.", + "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", "x-since-version": "v0.252.0" }, @@ -9774,6 +10289,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, "serving.ServingEndpointPermissionLevel": { @@ -9795,6 +10318,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, "serving.TrafficConfig": { @@ -9819,6 +10350,16 @@ "MIN", "MAX", "STDDEV" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "sql.AlertEvaluationState": { @@ -9829,6 +10370,12 @@ "TRIGGERED", "OK", "ERROR" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "sql.AlertLifecycleState": { @@ -9836,33 +10383,37 @@ "enum": [ "ACTIVE", "DELETED" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, "sql.AlertV2Evaluation": { "type": "object", "properties": { "comparison_operator": { - "description": "Operator used for comparison in alert evaluation.", + "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": "Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", + "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": "User or Notification Destination to notify when alert is triggered.", + "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": "Source column from result to use to evaluate alert", + "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": "Threshold to user for alert evaluation, can be a column or a value.", + "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" } @@ -9877,16 +10428,17 @@ "type": "object", "properties": { "notify_on_ok": { - "description": "Whether to notify alert subscribers when alert returns back to normal.", + "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": "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.", + "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" } @@ -9897,10 +10449,12 @@ "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" } @@ -9911,14 +10465,17 @@ "type": "object", "properties": { "aggregation": { + "description": "[Public Preview]", "$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" } @@ -9932,14 +10489,17 @@ "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" } @@ -9950,12 +10510,12 @@ "type": "object", "properties": { "service_principal_name": { - "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", + "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": "The email of an active workspace user. Can only set this field to their own email.", + "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" } @@ -9966,10 +10526,12 @@ "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" } @@ -10011,6 +10573,16 @@ "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": { @@ -10018,25 +10590,24 @@ "enum": [ "TYPE_UNSPECIFIED", "CLASSIC", - "PRO", - "REYDEN" + "PRO" ] }, "sql.CronSchedule": { "type": "object", "properties": { "pause_status": { - "description": "Indicate whether this schedule is paused or not.", + "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": "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", + "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": "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.", + "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" } @@ -10076,6 +10647,10 @@ "enum": [ "UNPAUSED", "PAUSED" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, "sql.SpotInstancePolicy": { @@ -10188,8 +10763,11 @@ "description": "Type of endpoint.", "enum": [ "STORAGE_OPTIMIZED", - "STANDARD", - "STANDARD_ON_ORION" + "STANDARD" + ], + "enumDescriptions": [ + "[Public Preview]", + "" ] }, "vectorsearch.IndexSubtype": { @@ -10199,6 +10777,11 @@ "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": { @@ -10207,6 +10790,10 @@ "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": { @@ -10215,6 +10802,10 @@ "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": { @@ -10359,6 +10950,12 @@ "$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": { @@ -10371,6 +10968,12 @@ "$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": { @@ -10766,6 +11369,12 @@ "$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" + } + }, "serving.AiGatewayRateLimit": { "type": "array", "items": { From 32161928de9b9e80ea85e0e303b3d01691c2d9ee Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 24 Jun 2026 13:40:50 +0000 Subject: [PATCH 10/31] Update jsonschema_for_docs.json for v1.5.0 --- bundle/schema/jsonschema_for_docs.json | 547 +++++++++++++++++++++---- 1 file changed, 459 insertions(+), 88 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 65218a69e7a..f31399f4c32 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -22,17 +22,17 @@ "type": "object", "properties": { "custom_description": { - "description": "[Public Preview]", + "description": "[Public Preview] Custom description for the alert. support mustache template.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "custom_summary": { - "description": "[Public Preview]", + "description": "[Public Preview] Custom summary for the alert. support mustache template.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "display_name": { - "description": "[Public Preview]", + "description": "[Public Preview] The display name of the alert.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, @@ -46,30 +46,33 @@ "x-since-version": "v0.282.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.279.0" }, "parent_path": { - "description": "[Public Preview]", + "description": "[Public Preview] The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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.279.0" }, "query_text": { - "description": "[Public Preview]", + "description": "[Public Preview] Text of the query to be run.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "run_as": { - "description": "[Public Preview]", + "description": "[Public Preview] Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs", "x-since-version": "v0.279.0" }, "run_as_user_name": { - "description": "[Public Preview]", + "description": "[Public Preview] The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use `run_as` field instead. This field will be removed in a future release.", "$ref": "#/$defs/string", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.279.0", @@ -81,7 +84,7 @@ "x-since-version": "v0.279.0" }, "warehouse_id": { - "description": "[Public Preview]", + "description": "[Public Preview] ID of the SQL warehouse attached to the alert.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -104,14 +107,14 @@ "x-since-version": "v0.243.0" }, "compute_max_instances": { - "description": "[Private Preview]", + "description": "[Private Preview] Maximum number of app instances. Must be set together with `compute_min_instances`.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, "compute_min_instances": { - "description": "[Private Preview]", + "description": "[Private Preview] Minimum number of app instances. Must be set together with `compute_max_instances`.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -141,7 +144,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", "x-since-version": "v0.268.0" }, @@ -151,7 +154,9 @@ "x-since-version": "v0.239.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.AppPermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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.239.0" }, "resources": { @@ -230,18 +235,22 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "level": { + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppPermissionLevel", "x-since-version": "v0.247.0" }, "service_principal_name": { + "description": "The name of the service principal granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "user_name": { + "description": "The name of the user granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" } @@ -255,18 +264,28 @@ "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", + "x-since-version": "v1.5.0" + }, "grants": { + "description": "The Unity Catalog privileges to grant to principals on this securable.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence of Unity Catalog privilege grants on this securable, where each item grants a set of `privileges` to a `principal` (a user, group, or service principal).\n\nSee [link](https://docs.databricks.com/data-governance/unity-catalog/manage-privileges/index.html).", "x-since-version": "v0.287.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.287.0" }, @@ -276,26 +295,32 @@ "x-since-version": "v0.298.0" }, "name": { + "description": "Name of catalog.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "options": { + "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string", "x-since-version": "v0.287.0" }, "properties": { + "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string", "x-since-version": "v0.287.0" }, "provider_name": { + "description": "The name of delta sharing provider.\n\nA Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "share_name": { + "description": "The name of the share under the share provider.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "storage_root": { + "description": "Storage root URL for managed tables within catalog.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" } @@ -350,10 +375,12 @@ "x-since-version": "v0.229.0" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", "x-since-version": "v0.229.0" }, "docker_image": { + "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", "x-since-version": "v0.229.0" }, @@ -403,11 +430,12 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", "x-since-version": "v0.268.0" }, @@ -422,7 +450,9 @@ "x-since-version": "v0.229.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.ClusterPermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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" }, "policy_id": { @@ -436,6 +466,7 @@ "x-since-version": "v0.257.0" }, "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine", "x-since-version": "v0.229.0" }, @@ -480,6 +511,7 @@ "x-since-version": "v0.285.0" }, "workload_type": { + "description": "Cluster Attributes showing for clusters workload types.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType", "x-since-version": "v0.229.0" } @@ -491,18 +523,22 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "level": { + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterPermissionLevel", "x-since-version": "v0.247.0" }, "service_principal_name": { + "description": "The name of the service principal granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "user_name": { + "description": "The name of the user granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" } @@ -554,7 +590,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -574,7 +610,9 @@ "x-since-version": "v0.234.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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.232.0" }, "serialized_dashboard": { @@ -610,12 +648,12 @@ "x-since-version": "v0.265.0" }, "database_name": { - "description": "[Public Preview] The name of the database (in a instance) associated with the catalog.", + "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -657,7 +695,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -677,7 +715,9 @@ "x-since-version": "v0.265.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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.265.0" }, "retention_window_in_days": { @@ -705,50 +745,63 @@ "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": { + "description": "The Unity Catalog privileges to grant to principals on this securable.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence of Unity Catalog privilege grants on this securable, where each item grants a set of `privileges` to a `principal` (a user, group, or service principal).\n\nSee [link](https://docs.databricks.com/data-governance/unity-catalog/manage-privileges/index.html).", "x-since-version": "v0.289.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$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" } @@ -778,6 +831,7 @@ "x-since-version": "v1.3.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v1.3.0" }, @@ -787,7 +841,9 @@ "x-since-version": "v1.3.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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": "v1.3.0" }, "serialized_space": { @@ -842,6 +898,7 @@ "x-since-version": "v0.229.0" }, "health": { + "description": "An optional set of health rules that can be defined for this job.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules", "x-since-version": "v0.229.0" }, @@ -851,7 +908,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -881,7 +938,9 @@ "x-since-version": "v0.241.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.JobPermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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" }, "queue": { @@ -890,6 +949,7 @@ "x-since-version": "v0.229.0" }, "run_as": { + "description": "The user or service principal that the job runs as, if specified in the request.\nThis field indicates the explicit configuration of `run_as` for the job.\nTo find the value in all cases, explicit or implicit, use `run_as_user_name`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs", "x-since-version": "v0.229.0" }, @@ -938,18 +998,22 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "level": { + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobPermissionLevel", "x-since-version": "v0.247.0" }, "service_principal_name": { + "description": "The name of the service principal granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "user_name": { + "description": "The name of the user granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" } @@ -995,7 +1059,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -1005,7 +1069,9 @@ "x-since-version": "v0.229.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.MlflowExperimentPermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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" }, "tags": { @@ -1024,18 +1090,22 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "level": { + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ExperimentPermissionLevel", "x-since-version": "v0.247.0" }, "service_principal_name": { + "description": "The name of the service principal granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "user_name": { + "description": "The name of the user granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" } @@ -1054,7 +1124,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -1064,7 +1134,9 @@ "x-since-version": "v0.229.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.MlflowModelPermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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" }, "tags": { @@ -1083,18 +1155,22 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "level": { + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.RegisteredModelPermissionLevel", "x-since-version": "v0.247.0" }, "service_principal_name": { + "description": "The name of the service principal granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "user_name": { + "description": "The name of the user granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" } @@ -1132,7 +1208,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -1142,7 +1218,9 @@ "x-since-version": "v0.229.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.ModelServingEndpointPermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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" }, "rate_limits": { @@ -1173,18 +1251,22 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "level": { + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServingEndpointPermissionLevel", "x-since-version": "v0.247.0" }, "service_principal_name": { + "description": "The name of the service principal granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "user_name": { + "description": "The name of the user granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" } @@ -1198,22 +1280,22 @@ "type": "object", "properties": { "group_name": { - "description": "The name of the group that has the permission set in level.", + "description": "The name of the group granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "level": { - "description": "The allowed permission for user, group, service principal defined for this permission.", + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$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.", + "description": "The name of the service principal granted the permission 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.", + "description": "The name of the user granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" } @@ -1309,7 +1391,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -1324,12 +1406,14 @@ "x-since-version": "v0.229.0" }, "parameters": { - "description": "[Beta]", + "description": "[Beta] Key/value map of default parameters to use for pipeline execution.\nMaximum total size: 10k characters (JSON format)", "$ref": "#/$defs/map/string", "x-since-version": "v1.2.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.PipelinePermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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" }, "photon": { @@ -1350,6 +1434,7 @@ "x-since-version": "v0.253.0" }, "run_as": { + "description": "Write-only setting, available only in Create/Update calls. Specifies the user or service principal that the pipeline runs as. If not specified, the pipeline runs as the user who created the pipeline.\n\nOnly `user_name` or `service_principal_name` can be specified. If both are specified, an error is thrown.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RunAs", "x-since-version": "v0.241.0" }, @@ -1363,6 +1448,13 @@ "$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, + "x-since-version": "v1.5.0" + }, "storage": { "description": "DBFS root directory for storing checkpoints and tables.", "$ref": "#/$defs/string", @@ -1402,18 +1494,22 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "level": { + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinePermissionLevel", "x-since-version": "v0.247.0" }, "service_principal_name": { + "description": "The name of the service principal granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" }, "user_name": { + "description": "The name of the user granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.247.0" } @@ -1439,6 +1535,7 @@ "x-since-version": "v0.287.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.287.0" }, @@ -1493,6 +1590,7 @@ "x-since-version": "v1.0.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v1.0.0" }, @@ -1515,6 +1613,7 @@ "x-since-version": "v1.4.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v1.4.0" }, @@ -1565,6 +1664,7 @@ "x-since-version": "v0.290.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.287.0" }, @@ -1628,11 +1728,14 @@ "x-since-version": "v0.287.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.287.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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.292.0" }, "pg_version": { @@ -1672,6 +1775,7 @@ "x-since-version": "v1.4.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v1.4.0" }, @@ -1705,6 +1809,10 @@ "resources.PostgresSyncedTable": { "type": "object", "properties": { + "accelerated_sync": { + "$ref": "#/$defs/bool", + "x-since-version": "v1.5.0" + }, "branch": { "$ref": "#/$defs/string", "x-since-version": "v1.0.0" @@ -1718,6 +1826,7 @@ "x-since-version": "v1.0.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v1.0.0" }, @@ -1748,6 +1857,10 @@ "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", + "x-since-version": "v1.5.0" } }, "additionalProperties": false, @@ -1790,7 +1903,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -1851,10 +1964,12 @@ "type": "object", "properties": { "aliases": { + "description": "List of aliases associated with the registered model", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RegisteredModelAlias", "x-since-version": "v0.273.0" }, "browse_only": { + "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.", "$ref": "#/$defs/bool", "x-since-version": "v0.273.0" }, @@ -1869,27 +1984,33 @@ "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": { + "description": "The Unity Catalog privileges to grant to principals on this securable.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence of Unity Catalog privilege grants on this securable, where each item grants a set of `privileges` to a `principal` (a user, group, or service principal).\n\nSee [link](https://docs.databricks.com/data-governance/unity-catalog/manage-privileges/index.html).", "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being 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" }, @@ -1899,6 +2020,7 @@ "x-since-version": "v0.229.0" }, "owner": { + "description": "The identifier of the user who owns the registered model", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, @@ -1913,10 +2035,12 @@ "x-since-version": "v0.229.0" }, "updated_at": { + "description": "Last-update timestamp of the registered model in milliseconds since the Unix epoch", "$ref": "#/$defs/int64", "x-since-version": "v0.273.0" }, "updated_by": { + "description": "The identifier of the user who updated the registered model last time", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" } @@ -1937,12 +2061,19 @@ "$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", + "x-since-version": "v1.5.0" + }, "grants": { + "description": "The Unity Catalog privileges to grant to principals on this securable.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence of Unity Catalog privilege grants on this securable, where each item grants a set of `privileges` to a `principal` (a user, group, or service principal).\n\nSee [link](https://docs.databricks.com/data-governance/unity-catalog/manage-privileges/index.html).", "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -1952,6 +2083,7 @@ "x-since-version": "v0.229.0" }, "properties": { + "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string", "x-since-version": "v0.229.0" }, @@ -1982,7 +2114,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -2006,12 +2138,12 @@ "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.", + "description": "The name of the group granted the permission 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.", + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.SecretScopePermissionLevel", "x-since-version": "v0.252.0" }, @@ -2021,7 +2153,7 @@ "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.", + "description": "The name of the user granted the permission level. This field translates to a `principal` field in secret scope ACL.", "$ref": "#/$defs/string", "x-since-version": "v0.252.0" } @@ -2054,7 +2186,7 @@ "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", + "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" }, @@ -2081,7 +2213,7 @@ "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", "x-since-version": "v0.268.0" }, @@ -2101,10 +2233,13 @@ "x-since-version": "v0.260.0" }, "permissions": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.SqlWarehousePermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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.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" }, @@ -2114,6 +2249,7 @@ "x-since-version": "v0.260.0" }, "warehouse_type": { + "description": "Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,\nyou must set to `PRO` and also set the field `enable_serverless_compute` to `true`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CreateWarehouseRequestWarehouseType", "x-since-version": "v0.260.0" } @@ -2124,18 +2260,22 @@ "type": "object", "properties": { "group_name": { + "description": "The name of the group granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.260.0" }, "level": { + "description": "The permission level to apply. The allowed levels depend on the resource type.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.WarehousePermissionLevel", "x-since-version": "v0.260.0" }, "service_principal_name": { + "description": "The name of the service principal granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.260.0" }, "user_name": { + "description": "The name of the user granted the permission level.", "$ref": "#/$defs/string", "x-since-version": "v0.260.0" } @@ -2149,26 +2289,27 @@ "type": "object", "properties": { "database_instance_name": { - "description": "[Public Preview]", + "description": "[Public Preview] Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, "logical_database_name": { - "description": "[Public Preview]", + "description": "[Public Preview] Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the `create_database_objects_is_missing` field in `spec`.", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "name": { - "description": "[Public Preview]", + "description": "[Public Preview] Full three-part (catalog, schema, table) name of the table.", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "spec": { - "description": "[Public Preview]", + "description": "[Public Preview] Specification of a synced database table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec", "x-since-version": "v0.266.0" } @@ -2182,33 +2323,38 @@ "type": "object", "properties": { "budget_policy_id": { - "description": "[Public Preview]", + "description": "[Public Preview] The budget policy id to be applied", "$ref": "#/$defs/string", "x-since-version": "v0.298.0" }, "endpoint_type": { + "description": "Type of endpoint", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType", "x-since-version": "v0.298.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$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": { + "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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.298.0" }, "target_qps": { - "description": "[Public Preview]", + "description": "[Public Preview] Target QPS for the endpoint. Mutually exclusive with num_replicas.\nThe actual replica count is calculated at index creation/sync time based on this value.\nBest-effort target; the system does not guarantee this QPS will be achieved.", "$ref": "#/$defs/int64", "x-since-version": "v0.299.2" }, "usage_policy_id": { - "description": "[Private Preview]", + "description": "[Private Preview] The usage policy id to be applied once we've migrated to usage policies", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -2225,39 +2371,48 @@ "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": { + "description": "The Unity Catalog privileges to grant to principals on this securable.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence of Unity Catalog privilege grants on this securable, where each item grants a set of `privileges` to a `principal` (a user, group, or service principal).\n\nSee [link](https://docs.databricks.com/data-governance/unity-catalog/manage-privileges/index.html).", "x-since-version": "v1.1.0" }, "index_subtype": { - "description": "[Beta]", + "description": "[Beta] The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype", "x-since-version": "v1.1.0" }, "index_type": { + "description": "There are 2 types of AI Search indexes:\n- `DELTA_SYNC`: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.\n- `DIRECT_ACCESS`: An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType", "x-since-version": "v1.1.0" }, "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$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" } @@ -2284,11 +2439,13 @@ "x-since-version": "v0.236.0" }, "grants": { + "description": "The Unity Catalog privileges to grant to principals on this securable.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "markdownDescription": "A Sequence of Unity Catalog privilege grants on this securable, where each item grants a set of `privileges` to a `principal` (a user, group, or service principal).\n\nSee [link](https://docs.databricks.com/data-governance/unity-catalog/manage-privileges/index.html).", "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.", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.268.0" }, @@ -2308,6 +2465,7 @@ "x-since-version": "v0.236.0" }, "volume_type": { + "description": "The type of the volume. An external volume is located in the specified external location.\nA managed volume is located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.\n[Learn more](https://docs.databricks.com/aws/en/volumes/managed-vs-external)", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.VolumeType", "x-since-version": "v0.236.0" } @@ -3129,6 +3287,7 @@ "x-since-version": "v0.283.0" }, "deployment_id": { + "description": "The unique id of the deployment.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, @@ -3143,10 +3302,12 @@ "x-since-version": "v0.283.0" }, "mode": { + "description": "The mode of which the deployment will manage the source code.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentMode", "x-since-version": "v0.239.0" }, "source_code_path": { + "description": "The workspace file system path of the source code used to create the app deployment. This is different from\n`deployment_artifacts.source_code_path`, which is the path used by the deployed app. The former refers\nto the original source code location of the app in the workspace during deployment creation, whereas\nthe latter provides a system generated stable snapshotted source code path used by the deployment.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" } @@ -3157,6 +3318,7 @@ "type": "object", "properties": { "source_code_path": { + "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" } @@ -3361,10 +3523,12 @@ "type": "object", "properties": { "id": { + "description": "Id of the job to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, "permission": { + "description": "Permissions to grant on the Job. Supported permissions are: \"CAN_MANAGE\", \"IS_OWNER\", \"CAN_MANAGE_RUN\", \"CAN_VIEW\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJobJobPermission", "x-since-version": "v0.239.0" } @@ -3412,14 +3576,17 @@ "type": "object", "properties": { "key": { + "description": "Key of the secret to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, "permission": { + "description": "Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: \"READ\", \"WRITE\", \"MANAGE\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecretSecretPermission", "x-since-version": "v0.239.0" }, "scope": { + "description": "Scope of the secret to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" } @@ -3444,10 +3611,12 @@ "type": "object", "properties": { "name": { + "description": "Name of the serving endpoint to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, "permission": { + "description": "Permission to grant on the serving endpoint. Supported permissions are: \"CAN_MANAGE\", \"CAN_QUERY\", \"CAN_VIEW\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpointServingEndpointPermission", "x-since-version": "v0.239.0" } @@ -3470,10 +3639,12 @@ "type": "object", "properties": { "id": { + "description": "Id of the SQL warehouse to grant permission on.", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, "permission": { + "description": "Permission to grant on the SQL warehouse. Supported permissions are: \"CAN_MANAGE\", \"CAN_USE\", \"IS_OWNER\".", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouseSqlWarehousePermission", "x-since-version": "v0.239.0" } @@ -3645,7 +3816,7 @@ "description": "A single telemetry export destination with its configuration and status.", "properties": { "unity_catalog": { - "description": "Unity Catalog Destinations for OTEL telemetry export.", + "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" } @@ -3657,17 +3828,17 @@ "description": "Unity Catalog Destinations for OTEL telemetry export.", "properties": { "logs_table": { - "description": "Unity Catalog table for OTEL logs.", + "description": "[Public Preview] Unity Catalog table for OTEL logs.", "$ref": "#/$defs/string", "x-since-version": "v0.294.0" }, "metrics_table": { - "description": "Unity Catalog table for OTEL metrics.", + "description": "[Public Preview] Unity Catalog table for OTEL metrics.", "$ref": "#/$defs/string", "x-since-version": "v0.294.0" }, "traces_table": { - "description": "Unity Catalog table for OTEL traces (spans).", + "description": "[Public Preview] Unity Catalog table for OTEL traces (spans).", "$ref": "#/$defs/string", "x-since-version": "v0.294.0" } @@ -3683,6 +3854,7 @@ "type": "object", "properties": { "queue_url": { + "description": "The AQS queue url in the format https://sqs.{region}.amazonaws.com/{account id}/{queue name}.\nOnly required for provided_sqs.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" } @@ -3714,14 +3886,17 @@ "type": "object", "properties": { "queue_url": { + "description": "The AQS queue url in the format https://{storage account}.queue.core.windows.net/{queue name}\nOnly required for provided_aqs.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" }, "resource_group": { + "description": "Optional resource group for the queue, event grid subscription, and external location storage\naccount.\nOnly required for locations with a service principal storage credential", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" }, "subscription_id": { + "description": "Optional subscription id for the queue, event grid subscription, and external location storage\naccount.\nRequired for locations with a service principal storage credential", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" } @@ -3733,6 +3908,7 @@ "description": "Encryption options that apply to clients connecting to cloud storage.", "properties": { "sse_encryption_details": { + "description": "Server-Side Encryption properties for clients communicating with AWS s3.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.SseEncryptionDetails", "x-since-version": "v0.289.0" } @@ -3795,6 +3971,7 @@ "type": "object", "properties": { "subscription_name": { + "description": "The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}.\nOnly required for provided_pubsub.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" } @@ -4087,18 +4264,22 @@ "x-since-version": "v0.273.0" }, "catalog_name": { + "description": "The name of the catalog containing the model version", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "id": { + "description": "The unique identifier of the alias", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "model_name": { + "description": "The name of the parent registered model of the model version, relative to parent schema", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "schema_name": { + "description": "The name of the schema containing the model version, relative to parent catalog", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, @@ -4115,10 +4296,12 @@ "description": "Server-Side Encryption properties for clients communicating with AWS s3.", "properties": { "algorithm": { + "description": "Sets the value of the 'x-amz-server-side-encryption' header in S3 request.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.SseEncryptionDetailsAlgorithm", "x-since-version": "v0.289.0" }, "aws_kms_key_arn": { + "description": "Optional. The ARN of the SSE-KMS key used with the S3 location, when algorithm = \"SSE-KMS\".\nSets the value of the 'x-amz-server-side-encryption-aws-kms-key-id' header.", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" } @@ -4178,6 +4361,7 @@ "description": "Attributes set during cluster creation which are related to Amazon Web Services.", "properties": { "availability": { + "description": "Availability type used for all subsequent nodes past the `first_on_demand` ones.\n\nNote: If `first_on_demand` is zero, this availability type will be used for the entire cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAvailability", "x-since-version": "v0.229.0" }, @@ -4202,6 +4386,7 @@ "x-since-version": "v0.229.0" }, "ebs_volume_type": { + "description": "The type of EBS volumes that will be launched with this cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.EbsVolumeType", "x-since-version": "v0.229.0" }, @@ -4242,9 +4427,15 @@ "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", + "x-since-version": "v1.5.0" + }, "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", @@ -4364,10 +4555,12 @@ "x-since-version": "v0.229.0" }, "data_security_mode": { + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", "x-since-version": "v0.229.0" }, "docker_image": { + "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", "x-since-version": "v0.229.0" }, @@ -4417,6 +4610,7 @@ "x-since-version": "v0.237.0" }, "kind": { + "description": "The kind of compute described by this compute specification.\n\nDepending on `kind`, different validations and default values will be applied.\n\nClusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not.\n* [is_single_node](/api/workspace/clusters/create#is_single_node)\n* [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime)\n\nBy using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind", "x-since-version": "v0.237.0" }, @@ -4441,6 +4635,7 @@ "x-since-version": "v0.257.0" }, "runtime_engine": { + "description": "Determines the cluster's runtime engine, either standard or Photon.\n\nThis field is not compatible with legacy `spark_version` values that contain `-photon-`.\nRemove `-photon-` from the `spark_version` and set `runtime_engine` to `PHOTON`.\n\nIf left unspecified, the runtime engine defaults to standard unless the spark_version\ncontains -photon-, in which case Photon will be used.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine", "x-since-version": "v0.229.0" }, @@ -4485,6 +4680,7 @@ "x-since-version": "v0.285.0" }, "workload_type": { + "description": "Cluster Attributes showing for clusters workload types.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType", "x-since-version": "v0.229.0" } @@ -4566,6 +4762,7 @@ "type": "object", "properties": { "basic_auth": { + "description": "Basic auth with username and password", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerBasicAuth", "x-since-version": "v0.229.0" }, @@ -4612,7 +4809,7 @@ "x-since-version": "v0.252.0" }, "java_dependencies": { - "description": "[Public Preview]", + "description": "[Public Preview] List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.271.0" } @@ -4624,6 +4821,7 @@ "description": "Attributes set during cluster creation which are related to GCP.", "properties": { "availability": { + "description": "This field determines whether the spark executors will be scheduled to run on preemptible\nVMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability", "x-since-version": "v0.229.0" }, @@ -5012,12 +5210,12 @@ "type": "object", "properties": { "key": { - "description": "[Public Preview] The key of the custom tag.", + "description": "[Beta] The key of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "value": { - "description": "[Public Preview] The value of the custom tag.", + "description": "[Beta] The value of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" } @@ -5164,6 +5362,13 @@ "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, + "x-since-version": "v1.5.0" + }, "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", @@ -5198,10 +5403,59 @@ "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, + "x-since-version": "v1.5.0" } }, "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, + "x-since-version": "v1.5.0" + }, + "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, + "x-since-version": "v1.5.0" + }, + "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, + "x-since-version": "v1.5.0" + } + }, + "additionalProperties": false, + "required": [ + "column_name", + "pg_type" + ] + }, "database.SyncedTableState": { "type": "string", "description": "The state of a synced table.", @@ -5529,6 +5783,7 @@ "description": "Configures the Lakeview Dashboard job task type.", "properties": { "dashboard_id": { + "description": "The identifier of the dashboard to refresh.", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, @@ -5540,6 +5795,7 @@ "x-since-version": "v0.289.0" }, "subscription": { + "description": "Optional: subscription configuration for sending the dashboard snapshot.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Subscription", "x-since-version": "v0.248.0" }, @@ -5694,6 +5950,7 @@ }, "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.", @@ -5932,6 +6189,7 @@ "x-since-version": "v0.229.0" }, "spec": { + "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip and java dependencies are supported.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Environment", "x-since-version": "v0.229.0" } @@ -6084,10 +6342,12 @@ "type": "object", "properties": { "metric": { + "description": "Specifies the health metric that is being evaluated for a particular health rule.\n\n* `RUN_DURATION_SECONDS`: Expected total time for a run in seconds.\n* `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_RECORDS`: An estimate of the maximum offset lag across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.\n* `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric", "x-since-version": "v0.229.0" }, "op": { + "description": "Specifies the operator used to compare the health metric value with the specified threshold.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthOperator", "x-since-version": "v0.229.0" }, @@ -6854,6 +7114,7 @@ "x-since-version": "v0.248.0" }, "subscribers": { + "description": "The list of subscribers to send the snapshot of the dashboard to.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionSubscriber", "x-since-version": "v0.248.0" } @@ -6864,10 +7125,12 @@ "type": "object", "properties": { "destination_id": { + "description": "A snapshot of the dashboard will be sent to the destination when the `destination_id` field is present.", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "user_name": { + "description": "A snapshot of the dashboard will be sent to the user's email when the `user_name` field is present.", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" } @@ -6993,13 +7256,14 @@ "x-since-version": "v0.229.0" }, "gen_ai_compute_task": { - "description": "[Private Preview]", + "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" }, @@ -7932,7 +8196,7 @@ "x-since-version": "v0.229.0" }, "netsuite_jar_path": { - "description": "[Private Preview]", + "description": "[Private Preview] Netsuite only configuration. When the field is set for a netsuite connector,\nthe jar stored in the field will be validated and added to the classpath of\npipeline's cluster.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -8193,44 +8457,56 @@ "description": "Meta Marketing (Meta Ads) specific options for ingestion", "properties": { "action_attribution_windows": { - "description": "[Beta] (Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", + "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", - "x-since-version": "v0.299.2" + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.299.2", + "deprecated": true }, "action_breakdowns": { - "description": "[Beta] (Optional) Action breakdowns to configure for data aggregation", + "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.action_breakdowns) Action breakdowns", "$ref": "#/$defs/slice/string", - "x-since-version": "v0.299.2" + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.299.2", + "deprecated": true }, "action_report_time": { - "description": "[Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", + "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", - "x-since-version": "v0.299.2" + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.299.2", + "deprecated": true }, "breakdowns": { - "description": "[Beta] (Optional) Breakdowns to configure for data aggregation", + "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.breakdowns) Breakdowns to configure", "$ref": "#/$defs/slice/string", - "x-since-version": "v0.299.2" + "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.", + "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) Granularity of data to pull (account, ad, adset, campaign)", + "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.level) Granularity of data to pull\n(account, ad, adset, campaign)", "$ref": "#/$defs/string", - "x-since-version": "v0.299.2" + "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", + "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) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", + "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", - "x-since-version": "v0.299.2" + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.299.2", + "deprecated": true } }, "additionalProperties": false @@ -8950,6 +9226,20 @@ "$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, + "x-since-version": "v1.5.0" + }, + "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, + "x-since-version": "v1.5.0" + }, "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", @@ -8992,8 +9282,15 @@ "$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, + "x-since-version": "v1.5.0" + }, "workday_report_parameters": { - "description": "[Private Preview]", + "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -9021,49 +9318,59 @@ "description": "TikTok Ads specific options for ingestion", "properties": { "data_level": { - "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "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" + "x-since-version": "v0.298.0", + "deprecated": true }, "dimensions": { - "description": "[Private Preview] (Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", + "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" + "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.\nIf not specified, defaults to 7 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] (Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", + "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" + "x-since-version": "v0.298.0", + "deprecated": true }, "query_lifetime": { - "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", + "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" + "x-since-version": "v0.298.0", + "deprecated": true }, "report_type": { - "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", + "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" + "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.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", + "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, @@ -9332,6 +9639,16 @@ "[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.", @@ -9346,6 +9663,38 @@ "[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, + "x-since-version": "v1.5.0" + }, + "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, + "x-since-version": "v1.5.0" + }, + "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, + "x-since-version": "v1.5.0" + } + }, + "additionalProperties": false, + "required": [ + "column_name", + "pg_type" + ] + }, "serving.Ai21LabsConfig": { "type": "object", "properties": { @@ -10281,7 +10630,7 @@ }, "serving.ServedModelInputWorkloadType": { "type": "string", - "description": "Please keep this in sync with with workload types in InferenceEndpointEntities.scala", + "description": "Please keep this in sync with workload types in InferenceEndpointEntities.scala.", "enum": [ "CPU", "GPU_MEDIUM", @@ -10310,7 +10659,7 @@ }, "serving.ServingModelWorkloadType": { "type": "string", - "description": "Please keep this in sync with with workload types in InferenceEndpointEntities.scala", + "description": "Please keep this in sync with workload types in InferenceEndpointEntities.scala.", "enum": [ "CPU", "GPU_MEDIUM", @@ -10465,7 +10814,7 @@ "type": "object", "properties": { "aggregation": { - "description": "[Public Preview]", + "description": "[Public Preview] If not set, the behavior is equivalent to using `First row` in the UI.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation", "x-since-version": "v0.279.0" }, @@ -10655,7 +11004,7 @@ }, "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+-------+--------------------------------------+--------------------------------+\n\nWhile including \"spot\" in the enum name may limit the the future\nextensibility of this field because it limits this enum to denoting \"spot or\nnot\", this is the field that PM recommends after discussion with customers\nper SC-48783.", + "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", @@ -10682,26 +11031,32 @@ "x-since-version": "v1.1.0" }, "columns_to_sync": { + "description": "[Optional] Select the columns to sync with the vector index. If you leave this field blank, all columns\nfrom the source table are synced with the index. The primary key column and embedding source column or\nembedding vector column are always synced.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "embedding_source_columns": { + "description": "The columns that contain the embedding source.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", "x-since-version": "v1.1.0" }, "embedding_vector_columns": { + "description": "The columns that contain the embedding vectors.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", "x-since-version": "v1.1.0" }, "embedding_writeback_table": { + "description": "[Optional] Name of the Delta table to sync the vector index contents and computed embeddings to.", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" }, "pipeline_type": { + "description": "Pipeline execution mode.\n- `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.\n- `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.PipelineType", "x-since-version": "v1.1.0" }, "source_table": { + "description": "The name of the source table.", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" } @@ -10712,14 +11067,17 @@ "type": "object", "properties": { "embedding_source_columns": { + "description": "The columns that contain the embedding source. The format should be array[double].", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", "x-since-version": "v1.1.0" }, "embedding_vector_columns": { + "description": "The columns that contain the embedding vectors. The format should be array[double].", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", "x-since-version": "v1.1.0" }, "schema_json": { + "description": "The schema of the index in JSON format.\nSupported types are `integer`, `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`.\nSupported types for vector column: `array\u003cfloat\u003e`, `array\u003cdouble\u003e`,`.", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" } @@ -10730,14 +11088,17 @@ "type": "object", "properties": { "embedding_model_endpoint_name": { + "description": "Name of the embedding model endpoint, used by default for both ingestion and querying.", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" }, "model_endpoint_name_for_query": { + "description": "Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" }, "name": { + "description": "Name of the column", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" } @@ -10748,10 +11109,12 @@ "type": "object", "properties": { "embedding_dimension": { + "description": "Dimension of the embedding vector", "$ref": "#/$defs/int", "x-since-version": "v1.1.0" }, "name": { + "description": "Name of the column", "$ref": "#/$defs/string", "x-since-version": "v1.1.0" } @@ -10764,10 +11127,6 @@ "enum": [ "STORAGE_OPTIMIZED", "STANDARD" - ], - "enumDescriptions": [ - "[Public Preview]", - "" ] }, "vectorsearch.IndexSubtype": { @@ -11231,6 +11590,12 @@ "$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": { @@ -11375,6 +11740,12 @@ "$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": { From 3ee3de879f3f2e14aa2de2f77f7a2414fd9c4b10 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 2 Jul 2026 12:57:47 +0000 Subject: [PATCH 11/31] Update jsonschema_for_docs.json for v1.6.0 --- bundle/schema/jsonschema_for_docs.json | 177 ++++++++++++++++++++++++- 1 file changed, 172 insertions(+), 5 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index f31399f4c32..afe34f2e7b5 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -1239,6 +1239,11 @@ "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" + }, + "telemetry_config": { + "description": "[Public Preview] Configuration for persisting endpoint telemetry (logs, traces, and metrics) to Unity Catalog tables.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TelemetryConfig", + "x-since-version": "v1.6.0" } }, "additionalProperties": false, @@ -2732,6 +2737,11 @@ "config.Experimental": { "type": "object", "properties": { + "immutable_folder": { + "description": "Whether to deploy bundle files and artifacts as a single immutable snapshot. When true, all files are packaged into a content-addressed archive and workspace.file_path and workspace.artifact_path are set to the resulting location.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.6.0" + }, "pydabs": { "description": "The PyDABs configuration.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config.PyDABs", @@ -3723,7 +3733,13 @@ "type": "string", "enum": [ "MEDIUM", - "LARGE" + "LARGE", + "XLARGE" + ], + "enumDescriptions": [ + "", + "", + "[Private Preview]" ] }, "apps.ComputeState": { @@ -4905,7 +4921,7 @@ }, "compute.InitScriptInfo": { "type": "object", - "description": "Config for an individual init script\nNext ID: 11", + "description": "Config for an individual init script", "properties": { "abfss": { "description": "Contains the Azure Data Lake Storage destination path", @@ -5566,6 +5582,52 @@ "[Private Preview]" ] }, + "jobs.AiRuntimeTask": { + "type": "object", + "description": "AiRuntimeTask: multi-node GPU compute task definition for Databricks AI\nRuntime workloads.\n\nJobs-framework-level concepts (retries, per-task timeout, idempotency\ntoken, usage/budget policy, permissions) live on the surrounding\nTaskSettings / run-submit request and are intentionally NOT duplicated\nhere. Users compose `ai_runtime_task` with the standard Jobs/DABs task\nwrapper to get those.", + "properties": { + "code_source_path": { + "description": "[Private Preview] Optional workspace or UC volume path of the uploaded code-source\narchive. The CLI packages the user's local code directory into an\narchive and populates this. Customers calling the Jobs API directly\nshould upload their archive to the workspace or a UC volume first and\nsupply the resulting path here.\n\nWhen set, the training node exposes the value via the `$CODE_SOURCE`\nenvironment variable.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + }, + "deployments": { + "description": "[Private Preview] Deployment specs for this task. Exactly one deployment is currently\nsupported (a single entry where every node runs the same command); this\nis a current-Preview constraint. Role-split workloads (driver + worker,\nparameter server, separate eval node, etc.) with multiple entries are the\neventual intent but not yet supported.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.DeploymentSpec", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + }, + "experiment": { + "description": "[Private Preview] MLflow experiment name for this run. If an experiment with this name\nalready exists under the calling user, the run is appended to it;\notherwise a new experiment is created. To target a specific MLflow\nstorage location (for example, when running as a service principal), set\n`mlflow_experiment_directory`.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + }, + "mlflow_experiment_directory": { + "description": "[Private Preview] Optional workspace directory under which the MLflow experiment named in\n`experiment` is created. Must start with `/Workspace`. Set this when\nrunning as a service principal that has no default user directory; for\nregular users the experiment defaults to the user's home directory.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + }, + "mlflow_run": { + "description": "[Private Preview] Optional display name for the MLflow run created under `experiment`. If\nomitted, MLflow generates a default name.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + } + }, + "additionalProperties": false, + "required": [ + "deployments", + "experiment" + ] + }, "jobs.AlertTask": { "type": "object", "properties": { @@ -5692,6 +5754,45 @@ "num_gpus" ] }, + "jobs.ComputeSpec": { + "type": "object", + "description": "ComputeSpec: compute configuration — accelerator type and total\naccelerator count across all nodes.", + "properties": { + "accelerator_count": { + "description": "[Private Preview] Total number of accelerators across all nodes. Must be a positive\nmultiple of the per-node accelerator count encoded in `accelerator_type`.\nFor example, `GPU_8xH100` with `accelerator_count: 16` allocates 2 nodes\n(8 GPUs per node).", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + }, + "accelerator_type": { + "description": "[Private Preview] Hardware accelerator type (for example, `GPU_1xA10` or `GPU_8xH100`).\nThe number of accelerators per node is encoded in the enum value —\n`GPU_8xH100` means 8 H100 GPUs per node.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpecAcceleratorType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + } + }, + "additionalProperties": false, + "required": [ + "accelerator_count", + "accelerator_type" + ] + }, + "jobs.ComputeSpecAcceleratorType": { + "type": "string", + "description": "Customer-facing AcceleratorType: hardware accelerator type for the\nAiRuntime workload. Per-node accelerator count is encoded in the value\nname (e.g. `GPU_8xH100` means 8 H100s per node).", + "enum": [ + "GPU_1xA10", + "GPU_1xH100", + "GPU_8xH100" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, "jobs.Condition": { "type": "string", "enum": [ @@ -5892,6 +5993,38 @@ "commands" ] }, + "jobs.DeploymentSpec": { + "type": "object", + "description": "DeploymentSpec: configuration for one deployment within an AiRuntimeTask.\nEach entry in `AiRuntimeTask.deployments` describes a group of nodes that\nshare the same command and compute. Many single-program training\nalgorithms use a single entry where every node runs the same command;\nrole-split workloads (driver + worker, parameter server, separate eval\nnode, etc.) use multiple entries.", + "properties": { + "command_path": { + "description": "[Private Preview] Workspace path of the bash script to execute on each node in this\ndeployment. The CLI uploads the user's script and populates this.\nCustomers calling the Jobs API directly should upload their script to\nthe workspace first and supply the resulting path here.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + }, + "compute": { + "description": "[Private Preview] Compute resources allocated to each node in this deployment.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpec", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + }, + "name": { + "description": "[Private Preview] Optional human-readable name for this deployment (for example, `driver`,\n`worker`, `param_server`). Used for log and UI display. Distinct names\nare recommended so deployments can be told apart, but uniqueness is not\nenforced.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + } + }, + "additionalProperties": false, + "required": [ + "command_path", + "compute" + ] + }, "jobs.FileArrivalTriggerConfiguration": { "type": "object", "properties": { @@ -7169,6 +7302,13 @@ "jobs.Task": { "type": "object", "properties": { + "ai_runtime_task": { + "description": "[Private Preview] The task runs a multi-node GPU compute workload on Databricks AI Runtime.\nExternal-facing surface; mirrors the AIR CLI (fka SGCLI) v2 YAML schema.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiRuntimeTask", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + }, "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", @@ -8914,10 +9054,8 @@ "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\"`.", + "description": "[Beta] 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" } }, @@ -10677,6 +10815,29 @@ "[Beta]" ] }, + "serving.TelemetryConfig": { + "type": "object", + "properties": { + "inference_table_config": { + "description": "[Public Preview] Configuration for inference table payload logging, including sampling.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TelemetryInferenceTableConfig", + "x-since-version": "v1.6.0" + } + }, + "additionalProperties": false + }, + "serving.TelemetryInferenceTableConfig": { + "type": "object", + "description": "Inference table payload logging configuration", + "properties": { + "sampling_fraction": { + "description": "[Public Preview] Fraction of requests sampled for payload logging, in the range [0.0, 1.0], where 1.0 logs all requests.", + "$ref": "#/$defs/float64", + "x-since-version": "v1.6.0" + } + }, + "additionalProperties": false + }, "serving.TrafficConfig": { "type": "object", "properties": { @@ -11602,6 +11763,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber" } }, + "jobs.DeploymentSpec": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DeploymentSpec" + } + }, "jobs.JobCluster": { "type": "array", "items": { From daa404634e8ea17f0a40dc345236e35a988740a2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 9 Jul 2026 10:54:47 +0000 Subject: [PATCH 12/31] Update jsonschema_for_docs.json for v1.7.0 --- bundle/schema/jsonschema_for_docs.json | 309 ++++++++++++++++++++++--- 1 file changed, 279 insertions(+), 30 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index afe34f2e7b5..fa377e3e1a5 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -440,7 +440,7 @@ "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.", + "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 [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, @@ -486,7 +486,7 @@ "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.", + "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 [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, @@ -932,6 +932,13 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobParameterDefinition", "x-since-version": "v0.229.0" }, + "parent_path": { + "description": "[Private Preview] Path of the job parent folder in workspace file tree. If absent, the job doesn't have a workspace object.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.7.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", @@ -1023,6 +1030,118 @@ "level" ] }, + "resources.JobRun": { + "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": "v1.7.0", + "deprecated": true + }, + "idempotency_token": { + "description": "An optional token to guarantee the idempotency of job run requests. If a run with the provided token already exists,\nthe request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted,\nan error is returned.\n\nIf you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly one run\nis launched with that idempotency token.\n\nThis token must have at most 64 characters.\n\nFor more information, see [How to ensure idempotency for jobs](https://kb.databricks.com/jobs/jobs-idempotency.html).", + "$ref": "#/$defs/string", + "x-since-version": "v1.7.0" + }, + "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": "v1.7.0", + "deprecated": true + }, + "job_id": { + "description": "The ID of the job to be executed", + "$ref": "#/$defs/int64", + "x-since-version": "v1.7.0" + }, + "job_parameters": { + "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", + "$ref": "#/$defs/map/string", + "x-since-version": "v1.7.0" + }, + "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.7.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": "v1.7.0", + "deprecated": true + }, + "only": { + "description": "A list of task keys to run inside of the job. If this field is not provided, all tasks in the job will be run.\n\nPrefix a task key with `+` to also run its upstream tasks, or suffix it with `+` to also run its downstream tasks.\nFor example, `+my_task` runs `my_task` and everything upstream of it, `my_task+` runs `my_task` and everything\ndownstream of it, and `+my_task+` runs both. A task key with no `+` runs only that task.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.7.0" + }, + "performance_target": { + "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\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": "v1.7.0" + }, + "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": "v1.7.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": "v1.7.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": "v1.7.0", + "deprecated": true + }, + "queue": { + "description": "The queue settings of the run.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings", + "x-since-version": "v1.7.0" + }, + "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": "v1.7.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": "v1.7.0", + "deprecated": true + } + }, + "additionalProperties": false, + "required": [ + "job_id" + ] + }, "resources.Lifecycle": { "type": "object", "properties": { @@ -1552,6 +1671,10 @@ "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, + "purge_on_delete": { + "$ref": "#/$defs/bool", + "x-since-version": "v1.7.0" + }, "replace_existing": { "$ref": "#/$defs/bool", "x-since-version": "v1.0.0" @@ -1630,6 +1753,11 @@ "$ref": "#/$defs/string", "x-since-version": "v1.4.0" }, + "replace_existing": { + "description": "When true, take over an existing database with the same ID instead of failing with an ALREADY_EXISTS error. Use it to bring a database that already exists on the branch under bundle management. Only takes effect when the database is created.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.7.0" + }, "role": { "$ref": "#/$defs/string", "x-since-version": "v1.4.0" @@ -1799,6 +1927,11 @@ "$ref": "#/$defs/string", "x-since-version": "v1.4.0" }, + "replace_existing": { + "description": "When true, take over an existing role with the same ID instead of failing with an ALREADY_EXISTS error. Use it to bring a role that already exists on the branch (for example, one inherited from the parent branch) under bundle management. Only takes effect when the role is created.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.7.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", @@ -2948,6 +3081,11 @@ "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.GenieSpace", "x-since-version": "v1.3.0" }, + "job_runs": { + "description": "The job run definitions for the bundle, where each key is the name of the job run. Each job run triggers a run of an existing job as part of bundle deployment.", + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.JobRun", + "x-since-version": "v1.7.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", @@ -4252,7 +4390,61 @@ "CREATE_CLEAN_ROOM", "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", - "EXTERNAL_USE_SCHEMA" + "EXTERNAL_USE_SCHEMA", + "READ_METADATA" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "[Public Preview]" ] }, "catalog.PrivilegeAssignment": { @@ -4329,9 +4521,7 @@ "description": "SSE algorithm to use for encrypting S3 objects", "enum": [ "AWS_SSE_S3", - "AWS_SSE_KMS", - "AWS_SSE_KMS", - "AWS_SSE_S3" + "AWS_SSE_KMS" ] }, "catalog.VolumeType": { @@ -4631,7 +4821,7 @@ "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.", + "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 [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, @@ -4671,7 +4861,7 @@ "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.", + "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 [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, @@ -5459,7 +5649,7 @@ "x-since-version": "v1.5.0" }, "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).", + "description": "[Private Preview] Size parameter for the target type. Required when pg_type is PG_SPECIFIC_TYPE_VECTOR\nor PG_SPECIFIC_TYPE_HALFVEC (specifies the vector dimension, e.g., 1024).", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -5867,6 +6057,13 @@ "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, + "sql_condition": { + "description": "[Private Preview] SQL condition that must be satisfied before a scheduled run is triggered. The condition is evaluated\nafter the cron expression fires and must return a truthy result for the run to proceed.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlConditionConfiguration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.7.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", @@ -7079,6 +7276,49 @@ }, "additionalProperties": false }, + "jobs.SqlConditionConfiguration": { + "type": "object", + "properties": { + "sql_query_id": { + "description": "[Private Preview] The ID of the SQL query to evaluate as the trigger condition.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.7.0" + }, + "trigger_mode": { + "description": "[Private Preview] Determines how the SQL query result is interpreted to decide whether the condition fires.\nMust be set to a recognized value when provided.\nWhen unset on an existing serialized configuration, the server preserves the original\nsemantics by interpreting it as `QUERY_RETURNS_ROWS`. New configurations should set this\nexplicitly — explicit `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED` is rejected at validation.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlConditionTriggerMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.7.0" + }, + "warehouse_id": { + "description": "[Private Preview] The canonical identifier of the SQL warehouse to run the condition query against.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.7.0" + } + }, + "additionalProperties": false, + "required": [ + "sql_query_id", + "warehouse_id" + ] + }, + "jobs.SqlConditionTriggerMode": { + "type": "string", + "description": "The strategy used to evaluate a SQL condition trigger against a query result set.\n\n* `SQL_CONDITION_TRIGGER_MODE_UNSPECIFIED`: Sentinel zero-value. Not a valid input — the\nvalidator rejects this when sent explicitly. Internally treated as `QUERY_RETURNS_ROWS`\nwhen reading legacy data that predates this field.\n* `QUERY_RETURNS_ROWS`: Fires whenever the result set has at least one row. Zero rows means\nthe condition is not met. This is the original SQL condition behavior.\n* `RESULT_VALUE_CHANGES`: Fires whenever the query's single result value differs from the\nprevious evaluation. The first evaluation always fires. Queries must return exactly one\ncell (one row, one column).", + "enum": [ + "QUERY_RETURNS_ROWS", + "RESULT_VALUE_CHANGES" + ], + "enumDescriptions": [ + "[Private Preview] Fires whenever the result set has at least one row. Zero rows means", + "[Private Preview] Fires whenever the query's single result value differs from the" + ] + }, "jobs.SqlTask": { "type": "object", "properties": { @@ -7633,6 +7873,13 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration", "x-since-version": "v0.229.0" }, + "sql_condition": { + "description": "[Private Preview] SQL condition that must be satisfied for the trigger to fire. Can be used in combination with other trigger types and\nruns *after* other trigger types conditions are evaluated.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlConditionConfiguration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.7.0" + }, "table_update": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration", "x-since-version": "v0.229.0" @@ -9365,17 +9612,13 @@ "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.", + "description": "[Beta] 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, "x-since-version": "v1.5.0" }, "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.", + "description": "[Beta] 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, "x-since-version": "v1.5.0" }, "exclude_columns": { @@ -9421,10 +9664,8 @@ "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.", + "description": "[Beta] 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, "x-since-version": "v1.5.0" }, "workday_report_parameters": { @@ -9784,7 +10025,7 @@ "PG_SPECIFIC_TYPE_VECTOR" ], "enumDescriptions": [ - "[Private Preview]" + "[Beta]" ] }, "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy": { @@ -9806,24 +10047,18 @@ "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.", + "description": "[Beta] Name of the source column whose target PostgreSQL type should be overridden.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.5.0" }, "pg_type": { - "description": "[Private Preview] PostgreSQL-specific target type to use for the column.", + "description": "[Beta] 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, "x-since-version": "v1.5.0" }, "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).", + "description": "[Beta] Size parameter for the target type. Required when pg_type is PG_SPECIFIC_TYPE_VECTOR\nor PG_SPECIFIC_TYPE_HALFVEC (specifies the vector dimension, e.g., 1024).", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.5.0" } }, @@ -10775,7 +11010,9 @@ "GPU_SMALL", "GPU_LARGE", "MULTIGPU_MEDIUM", - "GPU_XLARGE" + "CPU_LARGE", + "GPU_XLARGE", + "CPU_MEDIUM" ], "enumDescriptions": [ "", @@ -10783,6 +11020,8 @@ "", "", "", + "[Beta]", + "[Beta]", "[Beta]" ] }, @@ -10804,7 +11043,9 @@ "GPU_SMALL", "GPU_LARGE", "MULTIGPU_MEDIUM", - "GPU_XLARGE" + "CPU_LARGE", + "GPU_XLARGE", + "CPU_MEDIUM" ], "enumDescriptions": [ "", @@ -10812,6 +11053,8 @@ "", "", "", + "[Beta]", + "[Beta]", "[Beta]" ] }, @@ -11434,6 +11677,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Job" } }, + "resources.JobRun": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.JobRun" + } + }, "resources.MlflowExperiment": { "type": "object", "additionalProperties": { From 2199b7da9f4cc45a527de1b8fd357bb546b5b5ba Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 15 Jul 2026 14:33:46 +0000 Subject: [PATCH 13/31] Update jsonschema_for_docs.json for v1.8.0 --- bundle/schema/jsonschema_for_docs.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index fa377e3e1a5..7b6b78565b5 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -3197,6 +3197,11 @@ "content": { "$ref": "#/$defs/string", "x-since-version": "v0.259.0" + }, + "env": { + "description": "A map of environment variables to export when running the script. Values may reference `${bundle.*}`, `${workspace.*}`, and `${var.*}` and are resolved before the script runs; reference them from `content` with `$NAME`.", + "$ref": "#/$defs/map/string", + "x-since-version": "v1.8.0" } }, "additionalProperties": false, From 83b9eadad7b49cea0c98daaadc3a78051acc7ac9 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 12:21:06 +0000 Subject: [PATCH 14/31] Update jsonschema_for_docs.json for v1.9.0 --- bundle/schema/jsonschema_for_docs.json | 756 +++++++++++++++++++------ 1 file changed, 573 insertions(+), 183 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 7b6b78565b5..c019342cd11 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -22,22 +22,21 @@ "type": "object", "properties": { "custom_description": { - "description": "[Public Preview] Custom description for the alert. support mustache template.", + "description": "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.", + "description": "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.", + "description": "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" }, @@ -51,7 +50,7 @@ "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.", + "description": "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" }, @@ -62,29 +61,28 @@ "x-since-version": "v0.279.0" }, "query_text": { - "description": "[Public Preview] Text of the query to be run.", + "description": "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.", + "description": "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.", + "description": "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.", + "description": "ID of the SQL warehouse attached to the alert.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -864,6 +862,137 @@ }, "additionalProperties": false }, + "resources.InstancePool": { + "type": "object", + "properties": { + "aws_attributes": { + "description": "Attributes related to instance pools running on Amazon Web Services.\nIf not specified at pool creation, a set of default values will be used.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAwsAttributes", + "x-since-version": "v1.9.0" + }, + "azure_attributes": { + "description": "Attributes related to instance pools running on Azure.\nIf not specified at pool creation, a set of default values will be used.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAzureAttributes", + "x-since-version": "v1.9.0" + }, + "custom_tags": { + "description": "Additional tags for pool resources. Databricks will tag all pool 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", + "$ref": "#/$defs/map/string", + "x-since-version": "v1.9.0" + }, + "disk_spec": { + "description": "Defines the specification of the disks that will be attached to all spark containers.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskSpec", + "x-since-version": "v1.9.0" + }, + "enable_elastic_disk": { + "description": "Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire\nadditional disk space when its Spark workers are running low on disk space. In AWS, this\nfeature requires specific AWS permissions to function correctly - refer to the User Guide for\nmore details.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.9.0" + }, + "gcp_attributes": { + "description": "Attributes related to instance pools running on Google Cloud Platform.\nIf not specified at pool creation, a set of default values will be used.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolGcpAttributes", + "x-since-version": "v1.9.0" + }, + "idle_instance_autotermination_minutes": { + "description": "Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.", + "$ref": "#/$defs/int", + "x-since-version": "v1.9.0" + }, + "instance_pool_name": { + "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", + "$ref": "#/$defs/string", + "x-since-version": "v1.9.0" + }, + "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.9.0" + }, + "max_capacity": { + "description": "Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.", + "$ref": "#/$defs/int", + "x-since-version": "v1.9.0" + }, + "min_idle_instances": { + "description": "Minimum number of idle instances to keep in the instance pool", + "$ref": "#/$defs/int", + "x-since-version": "v1.9.0" + }, + "node_type_flexibility": { + "description": "Flexible node type configuration for the pool.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", + "x-since-version": "v1.9.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 [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.", + "$ref": "#/$defs/string", + "x-since-version": "v1.9.0" + }, + "permissions": { + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.InstancePoolPermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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": "v1.9.0" + }, + "preloaded_docker_images": { + "description": "Custom Docker Image BYOC", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", + "x-since-version": "v1.9.0" + }, + "preloaded_spark_versions": { + "description": "A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started\nwith the preloaded Spark version will start faster. A list of available Spark versions\ncan be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.9.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 types.", + "$ref": "#/$defs/int", + "x-since-version": "v1.9.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 types.", + "$ref": "#/$defs/int", + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false, + "required": [ + "instance_pool_name", + "node_type_id" + ], + "markdownDescription": "The instance pool resource defines an [instance pool](https://docs.databricks.com/api/workspace/instancepools/create), a set of idle, ready-to-use cloud instances that reduce cluster start and auto-scaling times." + }, + "resources.InstancePoolPermission": { + "type": "object", + "properties": { + "group_name": { + "description": "The name of the group granted the permission level.", + "$ref": "#/$defs/string", + "x-since-version": "v1.9.0" + }, + "level": { + "description": "The permission level to apply. The allowed levels depend on the resource type.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolPermissionLevel", + "x-since-version": "v1.9.0" + }, + "service_principal_name": { + "description": "The name of the service principal granted the permission level.", + "$ref": "#/$defs/string", + "x-since-version": "v1.9.0" + }, + "user_name": { + "description": "The name of the user granted the permission level.", + "$ref": "#/$defs/string", + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false, + "required": [ + "level" + ] + }, "resources.Job": { "type": "object", "properties": { @@ -1197,6 +1326,13 @@ "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" + }, + "trace_location": { + "description": "[Private Preview] The location where the experiment's traces are stored. When set, the\nunderlying storage is provisioned and the experiment's traces are routed\nto it. When unset, traces are stored in the default MLflow backend. This\nfield cannot be updated after the experiment is created.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTraceLocation", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" } }, "additionalProperties": false, @@ -1766,7 +1902,8 @@ "additionalProperties": false, "required": [ "database_id", - "parent" + "parent", + "role" ] }, "resources.PostgresEndpoint": { @@ -2106,11 +2243,6 @@ "$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", @@ -2324,7 +2456,7 @@ "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", + "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", "$ref": "#/$defs/string", "x-since-version": "v0.260.0" }, @@ -3081,6 +3213,12 @@ "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.GenieSpace", "x-since-version": "v1.3.0" }, + "instance_pools": { + "description": "The instance pool definitions for the bundle, where each key is the name of the instance pool.", + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.InstancePool", + "markdownDescription": "The instance pool definitions for the bundle, where each key is the name of the instance pool. See [instance_pools](https://docs.databricks.com/dev-tools/bundles/resources.html#instance_pools).", + "x-since-version": "v1.9.0" + }, "job_runs": { "description": "The job run definitions for the bundle, where each key is the name of the job run. Each job run triggers a run of an existing job as part of bundle deployment.", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.JobRun", @@ -4397,59 +4535,6 @@ "EXECUTE_CLEAN_ROOM_TASK", "EXTERNAL_USE_SCHEMA", "READ_METADATA" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "[Public Preview]" ] }, "catalog.PrivilegeAssignment": { @@ -4953,6 +5038,71 @@ "destination" ] }, + "compute.DiskSpec": { + "type": "object", + "description": "Describes the disks that are launched for each instance in the spark cluster.\nFor example, if the cluster has 3 instances, each instance is configured to launch\n2 disks, 100 GiB each, then Databricks will launch a total of 6 disks,\n100 GiB each, for this cluster.", + "properties": { + "disk_count": { + "description": "The number of disks launched for each instance:\n- This feature is only enabled for supported node types.\n- Users can choose up to the limit of the disks supported by the node type.\n- For node types with no OS disk, at least one disk must be specified;\notherwise, cluster creation will fail.\n\nIf disks are attached, Databricks will configure Spark to use only the disks for\nscratch storage, because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no disks are attached, Databricks will configure Spark to use\ninstance store disks.\n\nNote: If disks are specified, then the Spark configuration\n`spark.local.dir` will be overridden.\n\nDisks will be mounted at:\n- For AWS: `/ebs0`, `/ebs1`, and etc.\n- For Azure: `/remote_volume0`, `/remote_volume1`, and etc.", + "$ref": "#/$defs/int", + "x-since-version": "v1.9.0" + }, + "disk_iops": { + "description": "The number of IOPS to provision for each attached disk.", + "$ref": "#/$defs/int", + "x-since-version": "v1.9.0" + }, + "disk_size": { + "description": "The size of each disk (in GiB) launched for each instance.\nValues must fall into the supported range for a particular instance type.\n\nFor AWS:\n- General Purpose SSD: 100 - 4096 GiB\n- Throughput Optimized HDD: 500 - 4096 GiB\n\nFor Azure:\n- Premium LRS (SSD): 1 - 1023 GiB\n- Standard LRS (HDD): 1- 1023 GiB", + "$ref": "#/$defs/int", + "x-since-version": "v1.9.0" + }, + "disk_throughput": { + "description": "The disk throughput to provision for each attached disk, in MB per second.", + "$ref": "#/$defs/int", + "x-since-version": "v1.9.0" + }, + "disk_type": { + "description": "The type of disks that will be launched with this cluster.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskType", + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false + }, + "compute.DiskType": { + "type": "object", + "description": "Describes the disk type.", + "properties": { + "azure_disk_volume_type": { + "description": "All Azure Disk types that Databricks supports.\nSee https://docs.microsoft.com/en-us/azure/storage/storage-about-disks-and-vhds-linux#types-of-disks", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskTypeAzureDiskVolumeType", + "x-since-version": "v1.9.0" + }, + "ebs_volume_type": { + "description": "All EBS volume types that Databricks supports.\nSee https://aws.amazon.com/ebs/details/ for details.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskTypeEbsVolumeType", + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false + }, + "compute.DiskTypeAzureDiskVolumeType": { + "type": "string", + "description": "All Azure Disk types that Databricks supports.\nSee https://docs.microsoft.com/en-us/azure/storage/storage-about-disks-and-vhds-linux#types-of-disks", + "enum": [ + "PREMIUM_LRS", + "STANDARD_LRS" + ] + }, + "compute.DiskTypeEbsVolumeType": { + "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.DockerBasicAuth": { "type": "object", "properties": { @@ -5158,6 +5308,101 @@ }, "additionalProperties": false }, + "compute.InstancePoolAwsAttributes": { + "type": "object", + "description": "Attributes set during instance pool creation which are related to Amazon Web Services.", + "properties": { + "availability": { + "description": "Availability type used for the spot nodes.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAwsAttributesAvailability", + "x-since-version": "v1.9.0" + }, + "instance_profile_arn": { + "description": "[Beta] All AWS instances belonging to the instance pool will have this instance profile. If omitted, instances\nwill initially be launched with the workspace's default instance profile. If defined, clusters that use the\npool will inherit the instance profile, and must not specify their own instance profile on cluster creation or\nupdate. If the pool does not specify an instance profile, clusters using the pool may specify any instance profile.\nThe instance profile must have previously been added to the Databricks environment by an account administrator.\n\nThis feature may only be available to certain customer plans.", + "$ref": "#/$defs/string", + "x-since-version": "v1.9.0" + }, + "spot_bid_price_percent": { + "description": "Calculates 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": "v1.9.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, a default zone will be used.\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": "v1.9.0" + } + }, + "additionalProperties": false + }, + "compute.InstancePoolAwsAttributesAvailability": { + "type": "string", + "description": "The set of AWS availability types supported when setting up nodes for a cluster.", + "enum": [ + "SPOT", + "ON_DEMAND" + ] + }, + "compute.InstancePoolAzureAttributes": { + "type": "object", + "description": "Attributes set during instance pool creation which are related to Azure.", + "properties": { + "availability": { + "description": "Availability type used for the spot nodes.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAzureAttributesAvailability", + "x-since-version": "v1.9.0" + }, + "capacity_reservation_group": { + "description": "[Public Preview] The Azure capacity reservation group resource ID to use for launching VMs in this pool.\nWhen specified, VMs will be launched using the provided capacity reservation.\n\nNOTE: Omitting this field will clear any existing configured capacity reservation group on the pool.\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", + "x-since-version": "v1.9.0" + }, + "spot_bid_max_price": { + "description": "With variable pricing, you have option to set a max price, in US dollars (USD)\nFor example, the value 2 would be a max price of $2.00 USD per hour.\nIf you set the max price to be -1, the VM won't be evicted based on price.\nThe price for the VM will be the current price for spot or the price for a standard VM,\nwhich ever is less, as long as there is capacity and quota available.", + "$ref": "#/$defs/float64", + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false + }, + "compute.InstancePoolAzureAttributesAvailability": { + "type": "string", + "description": "The set of Azure availability types supported when setting up nodes for a cluster.", + "enum": [ + "SPOT_AZURE", + "ON_DEMAND_AZURE" + ] + }, + "compute.InstancePoolGcpAttributes": { + "type": "object", + "description": "Attributes set during instance pool creation which are related to GCP.", + "properties": { + "gcp_availability": { + "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.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability", + "x-since-version": "v1.9.0" + }, + "local_ssd_count": { + "description": "If provided, each node in the instance pool will have this number of local SSDs attached.\nEach local SSD is 375GB in size. Refer 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": "v1.9.0" + }, + "zone_id": { + "description": "Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west1-a\". The provided availability\nzone must be in the same region as the Databricks workspace. For example, \"us-west1-a\"\nis not a valid zone id if the Databricks workspace resides in the \"us-east1\" region.\nThis is an optional field at instance pool creation, and if not specified, a default zone will be used.\n\nThis field can be one of the following:\n- \"HA\" =\u003e High availability, spread nodes across availability zones for a Databricks deployment region\n- A GCP availability zone =\u003e Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones (e.g. \"us-west1-a\").\n\nIf empty, Databricks picks an availability zone to schedule the cluster on.", + "$ref": "#/$defs/string", + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false + }, + "compute.InstancePoolPermissionLevel": { + "type": "string", + "description": "Permission level", + "enum": [ + "CAN_MANAGE", + "CAN_ATTACH_TO" + ] + }, "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`.", @@ -5781,13 +6026,6 @@ "type": "object", "description": "AiRuntimeTask: multi-node GPU compute task definition for Databricks AI\nRuntime workloads.\n\nJobs-framework-level concepts (retries, per-task timeout, idempotency\ntoken, usage/budget policy, permissions) live on the surrounding\nTaskSettings / run-submit request and are intentionally NOT duplicated\nhere. Users compose `ai_runtime_task` with the standard Jobs/DABs task\nwrapper to get those.", "properties": { - "code_source_path": { - "description": "[Private Preview] Optional workspace or UC volume path of the uploaded code-source\narchive. The CLI packages the user's local code directory into an\narchive and populates this. Customers calling the Jobs API directly\nshould upload their archive to the workspace or a UC volume first and\nsupply the resulting path here.\n\nWhen set, the training node exposes the value via the `$CODE_SOURCE`\nenvironment variable.", - "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, - "x-since-version": "v1.6.0" - }, "deployments": { "description": "[Private Preview] Deployment specs for this task. Exactly one deployment is currently\nsupported (a single entry where every node runs the same command); this\nis a current-Preview constraint. Role-split workloads (driver + worker,\nparameter server, separate eval node, etc.) with multiple entries are the\neventual intent but not yet supported.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.DeploymentSpec", @@ -5976,7 +6214,7 @@ }, "jobs.ComputeSpecAcceleratorType": { "type": "string", - "description": "Customer-facing AcceleratorType: hardware accelerator type for the\nAiRuntime workload. Per-node accelerator count is encoded in the value\nname (e.g. `GPU_8xH100` means 8 H100s per node).", + "description": "Hardware accelerator type for the AiRuntime workload. Per-node\naccelerator count is encoded in the value name (e.g. `GPU_8xH100` means\n8 H100s per node).", "enum": [ "GPU_1xA10", "GPU_1xH100", @@ -6200,7 +6438,7 @@ "description": "DeploymentSpec: configuration for one deployment within an AiRuntimeTask.\nEach entry in `AiRuntimeTask.deployments` describes a group of nodes that\nshare the same command and compute. Many single-program training\nalgorithms use a single entry where every node runs the same command;\nrole-split workloads (driver + worker, parameter server, separate eval\nnode, etc.) use multiple entries.", "properties": { "command_path": { - "description": "[Private Preview] Workspace path of the bash script to execute on each node in this\ndeployment. The CLI uploads the user's script and populates this.\nCustomers calling the Jobs API directly should upload their script to\nthe workspace first and supply the resulting path here.", + "description": "[Private Preview] Workspace path of the script to run on each node in this deployment.\nUpload the script to this path and supply the path here. When the task\nruns, the file at this path is run on each node; if it fails, the task\nfails with its exit code.\n\nExample script contents:\n\n# Plain Python:\npython train.py --epochs 10\n\n# Multi-GPU via accelerate:\naccelerate launch train.py --config config.yaml\n\n# Distributed via torchrun:\ntorchrun --nproc_per_node=8 train.py", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -6836,7 +7074,8 @@ "enum": [ "HOURS", "DAYS", - "WEEKS" + "WEEKS", + "MINUTES" ] }, "jobs.PipelineParams": { @@ -7962,6 +8201,20 @@ }, "additionalProperties": false }, + "ml.ExperimentTraceLocation": { + "type": "object", + "description": "The storage location for an experiment's traces.", + "properties": { + "uc_trace_location": { + "description": "[Private Preview] A Unity Catalog schema where the experiment's traces are stored as\nDelta tables.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.UcTraceLocation", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false + }, "ml.ModelTag": { "type": "object", "description": "Tag for a registered model", @@ -7990,6 +8243,38 @@ "CAN_READ" ] }, + "ml.UcTraceLocation": { + "type": "object", + "description": "A Unity Catalog trace storage location. Traces are stored as Delta tables\nin the specified catalog and schema.", + "properties": { + "catalog": { + "description": "[Private Preview] The name of the Unity Catalog catalog.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "schema": { + "description": "[Private Preview] The name of the Unity Catalog schema within `catalog`.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "table_prefix": { + "description": "[Private Preview] The prefix for the trace tables, which are named\n`{catalog}.{schema}.{table_prefix}_otel_*`. May only contain letters,\ndigits, and underscores, and may be at most 238 characters. When unset, a\nserver-generated prefix derived from the experiment ID is used.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false, + "required": [ + "catalog", + "schema" + ] + }, "pipelines.AutoFullRefreshPolicy": { "type": "object", "description": "Policy for auto full refresh.", @@ -8064,10 +8349,8 @@ "x-since-version": "v0.299.2" }, "kafka_options": { - "description": "[Private Preview]", + "description": "[Beta]", "$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": { @@ -8360,11 +8643,11 @@ "NONE" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]" ] }, "pipelines.FileLibrary": { @@ -8407,10 +8690,55 @@ }, "additionalProperties": false }, + "pipelines.GoogleAdsCustomReportOptions": { + "type": "object", + "description": "User-defined custom report for the Google Ads connector. Mirrors the\nresource + fields + segments + metrics model that Google Ads GAQL exposes.\nThe customer account this report runs against is supplied by the source\nschema (namespace), not by this message. The whole message is gated by\nthe parent GoogleAdsOptions.custom_report_options stage; per-field stage\nannotations are intentionally omitted.\nOnly supported on table-type objects: a custom report requires a\ndestination table, so it cannot be specified at the schema/source level.", + "properties": { + "metrics": { + "description": "[Private Preview] (Optional) Metric fields to select (e.g. \"metrics.clicks\",\n\"metrics.cost_micros\"). Multiple values are joined into the GAQL\nSELECT clause.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "resource": { + "description": "[Private Preview] (Required) Google Ads resource to query (e.g. \"ad_group_ad\",\n\"keyword_view\", \"search_term_view\"). Must be a resource that has\nmetrics. Values are validated against Google Ads' field-service\ncatalog at pipeline plan time.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "resource_fields": { + "description": "[Private Preview] (Optional) Resource fields to select, in fully-qualified GAQL form\n(e.g. \"ad_group_ad.ad.id\", \"ad_group_ad.status\"). Multiple values are\njoined into the GAQL SELECT clause.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "segments": { + "description": "[Private Preview] (Optional) Segment fields to select (e.g. \"segments.date\",\n\"segments.device\"). Must include at least one of segments.date,\nsegments.week, or segments.month — that segment is used as the\nincremental cursor for the table.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false, + "required": [ + "resource" + ] + }, "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": { + "custom_report_options": { + "description": "[Private Preview] (Optional) Custom report definition. When set, the table is treated as a\nuser-defined Google Ads custom report: the connector synthesizes a GAQL\nquery from the resource, fields, segments, and metrics specified here.\nWhen unset, the table must match one of the connector's prebuilt sources.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsCustomReportOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, "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", @@ -8748,38 +9076,28 @@ "type": "object", "properties": { "as_variant": { - "description": "[Private Preview] Parse the entire value as a single Variant column.", + "description": "[Beta] 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).", + "description": "[Beta] 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.", + "description": "[Beta] (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).", + "description": "[Beta] 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.", + "description": "[Beta] (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" } }, @@ -8796,10 +9114,8 @@ "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.", + "description": "[Beta] (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": { @@ -8810,31 +9126,23 @@ "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\".", + "description": "[Beta] (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.", + "description": "[Beta] 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.", + "description": "[Beta] 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.", + "description": "[Beta] (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" } }, @@ -8881,6 +9189,13 @@ "$ref": "#/$defs/int", "x-since-version": "v0.299.2" }, + "custom_report_options": { + "description": "[Private Preview] (Optional) Per-table custom report definition. When set, defines the shape of the insights\ncall for this table (level/fields/breakdowns/action_breakdowns/etc.). Supersedes the deprecated\nflat report-shape fields above.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptionsMetaMarketingCustomReportOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, "level": { "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.level) Granularity of data to pull\n(account, ad, adset, campaign)", "$ref": "#/$defs/string", @@ -8903,6 +9218,55 @@ }, "additionalProperties": false }, + "pipelines.MetaMarketingOptionsMetaMarketingCustomReportOptions": { + "type": "object", + "description": "Defines the shape of a single Meta Ads custom report (one /insights call shape).\nstart_date, custom_insights_lookback_window live on MetaMarketingOptions, not here.\nMetrics are not customer-selectable; the connector returns a fixed standard metric set.", + "properties": { + "action_attribution_windows": { + "description": "[Private Preview] (Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "action_breakdowns": { + "description": "[Private Preview] (Optional) Action breakdowns to configure for data aggregation", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "action_report_time": { + "description": "[Private Preview] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "breakdowns": { + "description": "[Private Preview] (Optional) Breakdowns to configure for data aggregation", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "level": { + "description": "[Private Preview] (Optional) Granularity of data to pull (account, ad, adset, campaign)", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "time_increment": { + "description": "[Private Preview] (Optional) Value in string by which to aggregate statistics (all_days, monthly or number of days)", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false + }, "pipelines.NotebookLibrary": { "type": "object", "properties": { @@ -9668,6 +10032,13 @@ "$ref": "#/$defs/slice/string", "x-since-version": "v0.231.0" }, + "source_metadata_column": { + "description": "[Private Preview] (Optional) Name of the struct column added to each ingested record to hold per row source\nmetadata.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, "table_properties": { "description": "[Beta] 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", @@ -9701,6 +10072,13 @@ "type": "object", "description": "TikTok Ads specific options for ingestion", "properties": { + "custom_report_options": { + "description": "[Private Preview] (Optional) Custom report definition. When set, the table is treated as a\nuser-defined TikTok Ads custom report: the connector synthesizes a report\nrequest from the dimensions, metrics, report type, and data level specified\nhere. Supersedes the deprecated top-level dimensions/metrics/report_type/\ndata_level/query_lifetime fields above.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokAdsCustomReportOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, "data_level": { "description": "[Private Preview] Deprecated. Use custom_report_options.data_level instead.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", @@ -9763,6 +10141,48 @@ }, "additionalProperties": false }, + "pipelines.TikTokAdsOptionsTikTokAdsCustomReportOptions": { + "type": "object", + "description": "User-defined custom report for the TikTok Ads connector. Groups the\ndimensions + metrics + report type + data level that define a TikTok Ads\ncustom report request.", + "properties": { + "data_level": { + "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "dimensions": { + "description": "[Private Preview] (Optional) Dimensions to include in the report (e.g. \"campaign_id\",\n\"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\").", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "metrics": { + "description": "[Private Preview] (Optional) Metrics to include in the report (e.g. \"spend\", \"impressions\",\n\"clicks\", \"conversion\", \"cpc\").", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "query_lifetime": { + "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + }, + "report_type": { + "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false + }, "pipelines.TikTokAdsOptionsTikTokDataLevel": { "type": "string", "description": "Data level for TikTok Ads report aggregation.", @@ -9804,17 +10224,13 @@ "description": "Specifies how to transform binary data into structured data.", "properties": { "format": { - "description": "[Private Preview] Required: the wire format of the data.", + "description": "[Beta] 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]", + "description": "[Beta]", "$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" } }, @@ -9827,8 +10243,8 @@ "JSON" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]" ] }, "pipelines.ZendeskSupportOptions": { @@ -11108,16 +11524,6 @@ "MIN", "MAX", "STDDEV" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" ] }, "sql.AlertEvaluationState": { @@ -11128,12 +11534,6 @@ "TRIGGERED", "OK", "ERROR" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]", - "[Public Preview]", - "[Public Preview]" ] }, "sql.AlertLifecycleState": { @@ -11141,37 +11541,33 @@ "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.", + "description": "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.", + "description": "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.", + "description": "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", + "description": "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.", + "description": "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" } @@ -11186,17 +11582,16 @@ "type": "object", "properties": { "notify_on_ok": { - "description": "[Public Preview] Whether to notify alert subscribers when alert returns back to normal.", + "description": "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.", + "description": "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" } @@ -11207,12 +11602,10 @@ "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" } @@ -11223,17 +11616,15 @@ "type": "object", "properties": { "aggregation": { - "description": "[Public Preview] If not set, the behavior is equivalent to using `First row` in the UI.", + "description": "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" } @@ -11247,17 +11638,14 @@ "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" } @@ -11268,12 +11656,12 @@ "type": "object", "properties": { "service_principal_name": { - "description": "[Public Preview] Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", + "description": "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.", + "description": "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" } @@ -11284,12 +11672,10 @@ "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" } @@ -11331,16 +11717,6 @@ "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": { @@ -11355,17 +11731,17 @@ "type": "object", "properties": { "pause_status": { - "description": "[Public Preview] Indicate whether this schedule is paused or not.", + "description": "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", + "description": "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.", + "description": "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" } @@ -11405,10 +11781,6 @@ "enum": [ "UNPAUSED", "PAUSED" - ], - "enumDescriptions": [ - "[Public Preview]", - "[Public Preview]" ] }, "sql.SpotInstancePolicy": { @@ -11676,6 +12048,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.GenieSpace" } }, + "resources.InstancePool": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.InstancePool" + } + }, "resources.Job": { "type": "object", "additionalProperties": { @@ -11880,6 +12258,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ClusterPermission" } }, + "resources.InstancePoolPermission": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.InstancePoolPermission" + } + }, "resources.JobPermission": { "type": "array", "items": { @@ -11981,6 +12365,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.RegisteredModelAlias" } }, + "compute.DockerImage": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage" + } + }, "compute.InitScriptInfo": { "type": "array", "items": { From f93c0c7b15dcc0ce4d6cd0d08d349423401b63f8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 29 Jul 2026 15:58:50 +0000 Subject: [PATCH 15/31] Update jsonschema_for_docs.json for v1.10.0 --- bundle/schema/jsonschema_for_docs.json | 326 ++++++++++++++++++++++++- 1 file changed, 314 insertions(+), 12 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index c019342cd11..dda0246cdab 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -49,6 +49,13 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", "x-since-version": "v0.279.0" }, + "parameters": { + "description": "[Private Preview] Query parameters bound when executing the alert query, referenced in the\nquery text with `:name` syntax. Static values only.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertStatementParameter", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, "parent_path": { "description": "The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.", "$ref": "#/$defs/string", @@ -377,6 +384,11 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", "x-since-version": "v0.229.0" }, + "dependency_mode": { + "description": "[Beta] Controls dependency configuration for the cluster.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DependencyMode", + "x-since-version": "v1.10.0" + }, "docker_image": { "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", @@ -2100,6 +2112,10 @@ "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, + "extra_columns": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecExtraColumn", + "x-since-version": "v1.10.0" + }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", @@ -2614,12 +2630,12 @@ }, "permissions": { "description": "The permissions to apply to this resource.", - "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.VectorSearchEndpointPermission", "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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.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.", + "description": "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" }, @@ -2637,6 +2653,31 @@ "name" ] }, + "resources.VectorSearchEndpointPermission": { + "type": "object", + "properties": { + "group_name": { + "$ref": "#/$defs/string", + "x-since-version": "v1.10.0" + }, + "level": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorSearchEndpointPermissionLevel", + "x-since-version": "v1.10.0" + }, + "service_principal_name": { + "$ref": "#/$defs/string", + "x-since-version": "v1.10.0" + }, + "user_name": { + "$ref": "#/$defs/string", + "x-since-version": "v1.10.0" + } + }, + "additionalProperties": false, + "required": [ + "level" + ] + }, "resources.VectorSearchIndex": { "type": "object", "properties": { @@ -4016,11 +4057,6 @@ "MEDIUM", "LARGE", "XLARGE" - ], - "enumDescriptions": [ - "", - "", - "[Private Preview]" ] }, "apps.ComputeState": { @@ -4728,7 +4764,7 @@ "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}`", + "description": "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", "x-since-version": "v1.5.0" }, @@ -4855,6 +4891,11 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", "x-since-version": "v0.229.0" }, + "dependency_mode": { + "description": "[Beta] Controls dependency configuration for the cluster.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DependencyMode", + "x-since-version": "v1.10.0" + }, "docker_image": { "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", @@ -5038,6 +5079,20 @@ "destination" ] }, + "compute.DependencyMode": { + "type": "string", + "description": "Controls dependency configuration for the cluster.\n\n* `DEPENDENCY_MODE_AUTO`: Databricks will choose the most appropriate dependency mode based on your compute configuration.\n* `DEPENDENCY_MODE_ENVIRONMENTS`: Enables a unified dependency management experience across classic and serverless, resulting in increased stability and performance. Supported only on DBR 19+ in Standard access mode.\n* `DEPENDENCY_MODE_CLUSTER_LIBRARIES`: Legacy mode: dependencies come from cluster libraries and init scripts.", + "enum": [ + "DEPENDENCY_MODE_ENVIRONMENTS", + "DEPENDENCY_MODE_CLUSTER_LIBRARIES", + "DEPENDENCY_MODE_AUTO" + ], + "enumDescriptions": [ + "[Beta] Enables a unified dependency management experience across classic and serverless, resulting in increased stability and performance. Supported only on DBR 19+ in Standard access mode.", + "[Beta] Legacy mode: dependencies come from cluster libraries and init scripts.", + "[Beta] \u003cDatabricks\u003e will choose the most appropriate dependency mode based on your compute configuration." + ] + }, "compute.DiskSpec": { "type": "object", "description": "Describes the disks that are launched for each instance in the spark cluster.\nFor example, if the cluster has 3 instances, each instance is configured to launch\n2 disks, 100 GiB each, then Databricks will launch a total of 6 disks,\n100 GiB each, for this cluster.", @@ -5353,7 +5408,7 @@ "x-since-version": "v1.9.0" }, "capacity_reservation_group": { - "description": "[Public Preview] The Azure capacity reservation group resource ID to use for launching VMs in this pool.\nWhen specified, VMs will be launched using the provided capacity reservation.\n\nNOTE: Omitting this field will clear any existing configured capacity reservation group on the pool.\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}`", + "description": "The Azure capacity reservation group resource ID to use for launching VMs in this pool.\nWhen specified, VMs will be launched using the provided capacity reservation.\n\nNOTE: Omitting this field will clear any existing configured capacity reservation group on the pool.\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", "x-since-version": "v1.9.0" }, @@ -5899,7 +5954,7 @@ "x-since-version": "v1.5.0" }, "size": { - "description": "[Private Preview] Size parameter for the target type. Required when pg_type is PG_SPECIFIC_TYPE_VECTOR\nor PG_SPECIFIC_TYPE_HALFVEC (specifies the vector dimension, e.g., 1024).", + "description": "[Private Preview] Size parameter for the target type, for types that take one (e.g. vector\ndimension, varchar length). Required when the chosen pg_type needs a size.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -6026,6 +6081,13 @@ "type": "object", "description": "AiRuntimeTask: multi-node GPU compute task definition for Databricks AI\nRuntime workloads.\n\nJobs-framework-level concepts (retries, per-task timeout, idempotency\ntoken, usage/budget policy, permissions) live on the surrounding\nTaskSettings / run-submit request and are intentionally NOT duplicated\nhere. Users compose `ai_runtime_task` with the standard Jobs/DABs task\nwrapper to get those.", "properties": { + "code_source_path": { + "description": "[Private Preview] Workspace or UC volume path of the code-source archive, unpacked on\neach node and exposed through `$CODE_SOURCE`. Set by first-party\ntooling; not for direct callers.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.6.0" + }, "deployments": { "description": "[Private Preview] Deployment specs for this task. Exactly one deployment is currently\nsupported (a single entry where every node runs the same command); this\nis a current-Preview constraint. Role-split workloads (driver + worker,\nparameter server, separate eval node, etc.) with multiple entries are the\neventual intent but not yet supported.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.DeploymentSpec", @@ -6664,6 +6726,13 @@ "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" + }, + "serverless_compute_id": { + "description": "[Private Preview] The ID of the serverless compute object to bind this cluster to. At most one\nJobCluster per job may set this field; the rate limit defined on the referenced\nserverless compute applies across all tasks bound to this cluster.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" } }, "additionalProperties": false, @@ -8262,7 +8331,7 @@ "x-since-version": "v1.9.0" }, "table_prefix": { - "description": "[Private Preview] The prefix for the trace tables, which are named\n`{catalog}.{schema}.{table_prefix}_otel_*`. May only contain letters,\ndigits, and underscores, and may be at most 238 characters. When unset, a\nserver-generated prefix derived from the experiment ID is used.", + "description": "[Private Preview] The prefix for the trace tables, which are named\n`{catalog}.{schema}.{table_prefix}_otel_*`. May only contain letters,\ndigits, and underscores, and may be at most 238 characters. When unset, a\nserver-generated prefix derived from the experiment ID is used and this\nfield stays empty on read; the resolved value is always available in\n`effective_table_prefix`.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -8365,6 +8434,13 @@ "doNotSuggest": true, "x-since-version": "v0.299.2" }, + "reddit_ads_options": { + "description": "[Private Preview] Reddit Ads specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RedditAdsOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, "sharepoint_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions", @@ -8940,6 +9016,27 @@ }, "additionalProperties": false }, + "pipelines.IngestionPipelineDefinitionFanoutOptions": { + "type": "object", + "description": "Fanout configuration for multi-table routing from streaming sources.\nRoutes each input record to a destination table based on a routing\nkey derived from the record. The key value becomes the table name\nsuffix: {destination_catalog}.{destination_schema}.{key_value}.", + "properties": { + "fanout_by": { + "description": "[Private Preview] Column path or SQL expression whose value determines the destination table.\nSupports dotted paths (e.g. \"value.event_name\") and expressions\n(e.g. \"value:event_name::string\").", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, + "transforms": { + "description": "[Private Preview] Optional transforms applied to each route's DataFrame before writing\nto the destination table.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + } + }, + "additionalProperties": false + }, "pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig": { "type": "object", "description": "Configurations that are only applicable for query-based ingestion connectors.", @@ -9706,6 +9803,55 @@ }, "additionalProperties": false }, + "pipelines.RedditAdsOptions": { + "type": "object", + "description": "Reddit Ads specific options for ingestion", + "properties": { + "custom_report_options": { + "description": "[Private Preview] (Optional) Custom report definition. When set, the table is treated as a\nuser-defined Reddit Ads custom report. When unset, the table must match\none of the connector's prebuilt sources.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RedditAdsOptionsRedditAdsCustomReportOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, + "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.\nIf not specified, defaults to 30 days.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.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 ago.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + } + }, + "additionalProperties": false + }, + "pipelines.RedditAdsOptionsRedditAdsCustomReportOptions": { + "type": "object", + "description": "User-defined custom report for the Reddit Ads connector.\nApplies only to the custom_report table — prebuilt tables ignore this.", + "properties": { + "breakdowns": { + "description": "[Private Preview] (Optional) Breakdown dimensions to group report data by.\nExamples: CAMPAIGN_ID, DATE, COUNTRY, REGION, AD_ID.\nMust include at least one time dimension (DATE or HOUR).", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, + "fields": { + "description": "[Private Preview] (Optional) Fields to include in the report (maps to the Reddit Ads API `fields` parameter).\nExamples: IMPRESSIONS, CLICKS, SPEND, CPC, CTR.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + } + }, + "additionalProperties": false + }, "pipelines.ReportSpec": { "type": "object", "properties": { @@ -9807,6 +9953,13 @@ "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, + "fanout_options": { + "description": "[Private Preview] Fanout options for multi-table routing from streaming sources.\nWhen set, records are routed to destination tables based on a\nper-record routing key. The key value becomes the table name:\n{destination_catalog}.{destination_schema}.{key_value}.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionFanoutOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, "source_catalog": { "description": "[Public Preview] The source catalog name. Might be optional depending on the type of source.", "$ref": "#/$defs/string", @@ -10439,6 +10592,55 @@ "[Beta]" ] }, + "postgres.SyncedTableSyncedTableSpecExtraColumn": { + "type": "object", + "description": "An extra PostgreSQL column to add to the synced table.", + "properties": { + "column_name": { + "description": "[Private Preview] Name of the column.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, + "column_type": { + "description": "[Private Preview] PostgreSQL type of the column, for example \"tsvector\" or \"vector(1024)\".", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, + "compute": { + "description": "[Private Preview] SQL expression used to compute the column's value, for example\n\"to_tsvector('english', content)\".", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, + "maintenance": { + "description": "[Private Preview] How the column's value is populated and kept up to date.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecExtraColumnMaintenance", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + } + }, + "additionalProperties": false, + "required": [ + "column_name", + "column_type" + ] + }, + "postgres.SyncedTableSyncedTableSpecExtraColumnMaintenance": { + "type": "string", + "description": "How the column's value is populated and kept up to date.", + "enum": [ + "STORED_GENERATED" + ], + "enumDescriptions": [ + "[Private Preview]" + ] + }, "postgres.SyncedTableSyncedTableSpecPgSpecificType": { "type": "string", "description": "PostgreSQL-specific target types that can override the default Delta-to-PG mapping.", @@ -10478,7 +10680,7 @@ "x-since-version": "v1.5.0" }, "size": { - "description": "[Beta] Size parameter for the target type. Required when pg_type is PG_SPECIFIC_TYPE_VECTOR\nor PG_SPECIFIC_TYPE_HALFVEC (specifies the vector dimension, e.g., 1024).", + "description": "[Beta] Size parameter for the target type, for types that take one (e.g. vector\ndimension, varchar length). Required when the chosen pg_type needs a size.", "$ref": "#/$defs/int", "x-since-version": "v1.5.0" } @@ -11486,6 +11688,16 @@ "description": "[Public Preview] Configuration for inference table payload logging, including sampling.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TelemetryInferenceTableConfig", "x-since-version": "v1.6.0" + }, + "table_names": { + "description": "[Public Preview] The Unity Catalog tables to which endpoint telemetry (logs, traces, and metrics) is exported.\nProvide this to create a new telemetry profile for the endpoint from the given tables.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.UnityCatalogTableNames", + "x-since-version": "v1.10.0" + }, + "telemetry_profile_id": { + "description": "[Public Preview] The ID of an existing telemetry profile to apply to this endpoint. Provide this to reuse a\ntelemetry profile that has already been created, instead of specifying table_names.", + "$ref": "#/$defs/string", + "x-since-version": "v1.10.0" } }, "additionalProperties": false @@ -11513,6 +11725,32 @@ }, "additionalProperties": false }, + "serving.UnityCatalogTableNames": { + "type": "object", + "properties": { + "annotations_table": { + "description": "[Public Preview] The full three-level Unity Catalog name (catalog.schema.table) of the table that receives\nexported annotations.", + "$ref": "#/$defs/string", + "x-since-version": "v1.10.0" + }, + "logs_table": { + "description": "[Public Preview] The full three-level Unity Catalog name (catalog.schema.table) of the table that receives\nexported logs.", + "$ref": "#/$defs/string", + "x-since-version": "v1.10.0" + }, + "metrics_table": { + "description": "[Public Preview] The full three-level Unity Catalog name (catalog.schema.table) of the table that receives\nexported metrics.", + "$ref": "#/$defs/string", + "x-since-version": "v1.10.0" + }, + "traces_table": { + "description": "[Public Preview] The full three-level Unity Catalog name (catalog.schema.table) of the table that receives\nexported traces (spans).", + "$ref": "#/$defs/string", + "x-since-version": "v1.10.0" + } + }, + "additionalProperties": false + }, "sql.Aggregation": { "type": "string", "enum": [ @@ -11543,6 +11781,37 @@ "DELETED" ] }, + "sql.AlertStatementParameter": { + "type": "object", + "description": "Redash-owned copy of the internal StatementParameter for the external AlertV2 API.\nThe internal `ordinal` and `args` fields are intentionally omitted: the public API\nsupports only flat, named scalar parameters; complex types (ARRAY, MAP, STRUCT) are\nnot supported. This mirrors SEA's public StatementParameter schema, see:\ncmdexec/sql-exec-api/proto/sql_exec_api_service.proto:763-779", + "properties": { + "name": { + "description": "[Private Preview] The name of the parameter, referenced in the query as `:name`.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, + "type": { + "description": "[Private Preview] The SQL data type of the parameter, e.g. STRING, INT, or DATE. Defaults to STRING. This is a\nstring rather than an enum because scalar subtypes such as DECIMAL(10, 4) cannot be enumerated.\nComplex types such as ARRAY, MAP, and STRUCT are not supported.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + }, + "value": { + "description": "[Private Preview] The bound value for the parameter, given as a string. If omitted, the value is interpreted as NULL.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.10.0" + } + }, + "additionalProperties": false, + "required": [ + "name" + ] + }, "sql.AlertV2Evaluation": { "type": "object", "properties": { @@ -11948,6 +12217,15 @@ "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." ] }, + "vectorsearch.VectorSearchEndpointPermissionLevel": { + "type": "string", + "description": "Permission level", + "enum": [ + "CAN_CREATE", + "CAN_MANAGE", + "CAN_USE" + ] + }, "workspace.AzureKeyVaultSecretScopeMetadata": { "type": "object", "description": "The metadata of the Azure KeyVault for a secret scope of type `AZURE_KEYVAULT`", @@ -12311,6 +12589,12 @@ "items": { "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.SqlWarehousePermission" } + }, + "resources.VectorSearchEndpointPermission": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.VectorSearchEndpointPermission" + } } }, "config.ArtifactFile": { @@ -12539,6 +12823,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig" } }, + "pipelines.Transformer": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer" + } + }, "postgres.ProjectCustomTag": { "type": "array", "items": { @@ -12551,6 +12841,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleMembershipRole" } }, + "postgres.SyncedTableSyncedTableSpecExtraColumn": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecExtraColumn" + } + }, "postgres.SyncedTableSyncedTableSpecTypeOverride": { "type": "array", "items": { @@ -12593,6 +12889,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput" } }, + "sql.AlertStatementParameter": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertStatementParameter" + } + }, "sql.AlertV2Subscription": { "type": "array", "items": { From 7ac12e961c8918266860ecf189eb23e22afc040f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 6 Aug 2026 08:47:01 +0000 Subject: [PATCH 16/31] Update jsonschema_for_docs.json for v1.11.0 --- bundle/schema/jsonschema_for_docs.json | 125 +++++++++++++++++-------- 1 file changed, 84 insertions(+), 41 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index dda0246cdab..5c672837643 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -1795,14 +1795,17 @@ "type": "object", "properties": { "branch_id": { + "description": "The ID to use for the branch; becomes the final component of the branch's resource name. Must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens. For example, `development` becomes `projects/my-app/branches/development`.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "expire_time": { + "description": "[Beta] Absolute expiration timestamp. When set, the branch will expire at this time.\nMutually exclusive with `ttl` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", "x-since-version": "v0.287.0" }, "is_protected": { + "description": "[Beta] When set to true, protects the branch from deletion and reset. Associated compute endpoints and the project cannot be deleted while the branch is protected.", "$ref": "#/$defs/bool", "x-since-version": "v0.287.0" }, @@ -1812,34 +1815,42 @@ "x-since-version": "v0.287.0" }, "no_expiry": { + "description": "[Beta] Explicitly disable expiration. When set to true, the branch will not expire.\nIf set to false, the request is invalid; provide either ttl or expire_time instead.\nMutually exclusive with `expire_time` and `ttl`. When updating, use `spec.expiration` in the update_mask.", "$ref": "#/$defs/bool", "x-since-version": "v0.287.0" }, "parent": { + "description": "The project containing this branch (API resource hierarchy). Format: projects/{project_id}\n\nThis field indicates where the branch exists in the resource hierarchy. For point-in-time branching from another branch, see `source_branch`.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "purge_on_delete": { + "description": "When true, permanently delete the branch when the bundle is destroyed. When false or unset, the branch is soft deleted and can be restored within its retention window.", "$ref": "#/$defs/bool", "x-since-version": "v1.7.0" }, "replace_existing": { + "description": "When true, take over an existing branch with the same ID instead of failing with an ALREADY_EXISTS error. Use it to bring a branch that already exists on the project (for example, the production branch created with the project) under bundle management. Only takes effect when the branch is created.", "$ref": "#/$defs/bool", "x-since-version": "v1.0.0" }, "source_branch": { + "description": "[Beta] The name of the source branch from which this branch was created (data lineage for point-in-time recovery).\nIf not specified, defaults to the project's default branch.\nFormat: projects/{project_id}/branches/{branch_id}", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "source_branch_lsn": { + "description": "[Beta] The Log Sequence Number (LSN) on the source branch from which this branch was created.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "source_branch_time": { + "description": "[Beta] The point in time on the source branch from which this branch was created.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", "x-since-version": "v0.287.0" }, "ttl": { + "description": "[Beta] Relative time-to-live duration. When set, the branch will expire at creation_time + ttl.\nMutually exclusive with `expire_time` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", "x-since-version": "v0.287.0" } @@ -1852,16 +1863,20 @@ }, "resources.PostgresCatalog": { "type": "object", + "description": "The desired state of the Catalog.", "properties": { "branch": { + "description": "[Beta] The resource path of the branch associated with the catalog.\n\nFormat: projects/{project_id}/branches/{branch_id}.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "catalog_id": { + "description": "The ID of the catalog in Unity Catalog; becomes the full resource name. For example, `my_catalog` becomes `catalogs/my_catalog`.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "create_database_if_missing": { + "description": "[Beta] If set to true, the specified postgres_database is created on behalf of the calling user\nif it does not already exist. In this case, the calling user has a role created for\nthem in Postgres if they do not already have one.\n\nDefaults to false, meaning that the request fails if the specified postgres_database does not already exist.", "$ref": "#/$defs/bool", "x-since-version": "v1.0.0" }, @@ -1871,6 +1886,7 @@ "x-since-version": "v1.0.0" }, "postgres_database": { + "description": "[Beta] The name of the Postgres database inside the specified Lakebase project and branch to be associated with the UC catalog.\nThis database must already exist, unless create_database_if_missing is set to true on creation.\n\nA database can only be registered with one UC catalog at a time.\nTo re-register a database with a different catalog, the existing catalog must be deleted first.\n\nA child branch inherits the fact of parent's registration. This means the same-named database\nin a child branch cannot be registered with a second catalog\nwhile the parent's registration exists. To allow registering the database of a child branch,\ndrop and recreate the database on the child branch.\nThis removes the fact of parent's registration from this branch only.\n\nDoing Point In Time Restore (PITR) prior to the moment before the Postgres DB was registered\nin the Catalog drops the fact of registration of the database. So the user should avoid doing so.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" } @@ -1885,6 +1901,7 @@ "type": "object", "properties": { "database_id": { + "description": "The ID to use for the database; becomes the final component of the database's resource name and the database name in Postgres. Must be 4-63 characters and use only characters available in DNS names, as defined by RFC 1123. If not specified, it is generated automatically.", "$ref": "#/$defs/string", "x-since-version": "v1.4.0" }, @@ -1894,10 +1911,12 @@ "x-since-version": "v1.4.0" }, "parent": { + "description": "The branch containing this database. Format: projects/{project_id}/branches/{branch_id}", "$ref": "#/$defs/string", "x-since-version": "v1.4.0" }, "postgres_database": { + "description": "[Beta] The name of the Postgres database.\n\nThis expects a valid Postgres identifier as specified in the link below.\nhttps://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS\nRequired when creating the Database.\n\nTo rename, pass a valid postgres identifier when updating the Database.", "$ref": "#/$defs/string", "x-since-version": "v1.4.0" }, @@ -1907,6 +1926,7 @@ "x-since-version": "v1.7.0" }, "role": { + "description": "[Beta] The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nTo change the owner, pass valid existing Role name when updating the Database\n\nA database always has an owner.", "$ref": "#/$defs/string", "x-since-version": "v1.4.0" } @@ -1922,26 +1942,32 @@ "type": "object", "properties": { "autoscaling_limit_max_cu": { + "description": "[Beta] The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16.", "$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" }, "disabled": { + "description": "[Beta] Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action.", "$ref": "#/$defs/bool", "x-since-version": "v0.287.0" }, "endpoint_id": { + "description": "The ID to use for the endpoint; becomes the final component of the endpoint's resource name. Must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens. For example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "endpoint_type": { + "description": "[Beta] The endpoint type. A branch can only have one READ_WRITE endpoint.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointType", "x-since-version": "v0.287.0" }, "group": { + "description": "[Beta] Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults\nto non HA settings, with a single compute backing the endpoint (and no readable secondaries\nfor Read/Write endpoints).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec", "x-since-version": "v0.290.0" }, @@ -1951,22 +1977,27 @@ "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.suspension` in the update_mask.", "$ref": "#/$defs/bool", "x-since-version": "v0.287.0" }, "parent": { + "description": "The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "replace_existing": { + "description": "When true, take over an existing endpoint with the same ID instead of failing with an ALREADY_EXISTS error. Use it to bring an endpoint that already exists on the branch (for example, the primary read-write endpoint created with the branch) under bundle management. Only takes effect when the endpoint is created.", "$ref": "#/$defs/bool", "x-since-version": "v1.0.0" }, "settings": { + "description": "[Beta] A collection of settings for a compute endpoint.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings", "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.suspension` in the update_mask.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", "x-since-version": "v0.287.0" } @@ -1982,30 +2013,37 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "[Beta] The desired budget policy to associate with the project.\nSee status.budget_policy_id for the policy that is actually applied to the project.", "$ref": "#/$defs/string", "x-since-version": "v0.290.0" }, "custom_tags": { + "description": "[Beta] Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking.\nTo update tags, provide the new tag list and include \"spec.custom_tags\" in the update_mask.\nTo clear all tags, provide an empty list and include \"spec.custom_tags\" in the update_mask.\nTo preserve existing tags, omit this field from the update_mask (or use wildcard \"*\" which auto-excludes empty tags).", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.ProjectCustomTag", "x-since-version": "v0.290.0" }, "default_branch": { + "description": "[Beta] The full resource path for the default branch of the project\nFormat: projects/{project_id}/branches/{branch_id}", "$ref": "#/$defs/string", "x-since-version": "v0.298.0" }, "default_endpoint_settings": { + "description": "[Beta] A collection of settings for a compute endpoint.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.ProjectDefaultEndpointSettings", "x-since-version": "v0.287.0" }, "display_name": { + "description": "[Beta] Human-readable project name. Length should be between 1 and 256 characters.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "enable_pg_native_login": { + "description": "[Beta] Whether to enable PG native password login on all endpoints in this project. Defaults to false.", "$ref": "#/$defs/bool", "x-since-version": "v0.294.0" }, "history_retention_duration": { + "description": "[Beta] The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", "x-since-version": "v0.287.0" }, @@ -2021,14 +2059,17 @@ "x-since-version": "v0.292.0" }, "pg_version": { + "description": "[Beta] The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values.", "$ref": "#/$defs/int", "x-since-version": "v0.287.0" }, "project_id": { + "description": "The ID to use for the project; becomes the final component of the project's resource name. Must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens. For example, `my-app` becomes `projects/my-app`.", "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, "purge_on_delete": { + "description": "When true, permanently delete the project when the bundle is destroyed. When false or unset, the project is soft deleted and can be restored within its retention window.", "$ref": "#/$defs/bool", "x-since-version": "v1.2.0" } @@ -2042,17 +2083,17 @@ "type": "object", "properties": { "attributes": { - "description": "The desired API-exposed Postgres role attributes to associate with the role.", + "description": "[Beta] 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.", + "description": "[Beta] 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.", + "description": "[Beta] 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" }, @@ -2062,7 +2103,7 @@ "x-since-version": "v1.4.0" }, "membership_roles": { - "description": "Standard roles that this role is a member of.", + "description": "[Beta] 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" }, @@ -2072,7 +2113,7 @@ "x-since-version": "v1.4.0" }, "postgres_role": { - "description": "The name of the Postgres role. Required when creating the role.", + "description": "[Beta] The name of the Postgres role. Required when creating the role.", "$ref": "#/$defs/string", "x-since-version": "v1.4.0" }, @@ -2097,23 +2138,32 @@ "type": "object", "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 through Lakebase Accelerated Sync preview.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v1.5.0" }, "branch": { + "description": "[Beta] The full resource name the branch associated with the table.\n\nFormat: \"projects/{project_id}/branches/{branch_id}\".", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "create_database_objects_if_missing": { + "description": "[Beta] If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.\nThe request will fail if this is false and the database/schema do not exist.\n\nDefaults to true if omitted.", "$ref": "#/$defs/bool", "x-since-version": "v1.0.0" }, "existing_pipeline_id": { + "description": "[Beta] ID of an existing pipeline to bin-pack this synced table into.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "extra_columns": { + "description": "[Private Preview] Extra PostgreSQL-only columns to add to the synced table.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecExtraColumn", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v1.10.0" }, "lifecycle": { @@ -2122,34 +2172,42 @@ "x-since-version": "v1.0.0" }, "new_pipeline_spec": { + "description": "[Beta] Specification for creating a new pipeline.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.NewPipelineSpec", "x-since-version": "v1.0.0" }, "postgres_database": { + "description": "[Beta] The Postgres database name where the synced table will be created in.\n\nIf this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred\nfrom the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.\n\nA value must be specified when creating a synced table inside a Standard Catalog.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "primary_key_columns": { + "description": "[Beta] Primary Key columns to be used for data insert/update in the destination.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.0.0" }, "scheduling_policy": { + "description": "[Beta] Scheduling policy of the underlying pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy", "x-since-version": "v1.0.0" }, "source_table_full_name": { + "description": "[Beta] Three-part (catalog, schema, table) name of the source Delta table.\n\nFor the corresponding destination table, use any of the two:\n\n* synced_table_id used at the creation of the SyncedTable\n* \"name\" consisting of \"synced_tables/\" prefix and the full name of the destination table.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "synced_table_id": { + "description": "The ID to use for the synced table; becomes the final component of the synced table's resource name. It is the synced table name, a `{catalog}.{schema}.{table}` tuple of Unity Catalog entity names.\n\nIt names both an online view in Unity Catalog, accessible through Lakehouse Federation, and a Postgres table named `{table}` in schema `{schema}` in the connected Postgres database.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "timeseries_key": { + "description": "[Beta] Time series key to deduplicate (tie-break) rows with the same primary key.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "type_overrides": { + "description": "[Beta] 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/postgres.SyncedTableSyncedTableSpecTypeOverride", "x-since-version": "v1.5.0" } @@ -3290,6 +3348,7 @@ "x-since-version": "v0.229.0" }, "postgres_branches": { + "description": "The Postgres branch definitions for the bundle, where each key is the name of the branch. Each entry defines a branch of a Lakebase Autoscaling project, holding its own copy of the project's databases and roles.", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresBranch", "x-since-version": "v0.287.0" }, @@ -3299,18 +3358,22 @@ "x-since-version": "v1.0.0" }, "postgres_databases": { + "description": "The Postgres database definitions for the bundle, where each key is the name of the database. Each entry defines a database on a Lakebase Autoscaling branch.", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresDatabase", "x-since-version": "v1.4.0" }, "postgres_endpoints": { + "description": "The Postgres endpoint definitions for the bundle, where each key is the name of the endpoint. Each entry defines a compute endpoint that serves queries for a Lakebase Autoscaling branch.", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresEndpoint", "x-since-version": "v0.287.0" }, "postgres_projects": { + "description": "The Postgres project definitions for the bundle, where each key is the name of the project. Each entry defines a Lakebase Autoscaling project, the top-level container for branches, endpoints, databases, and roles.", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresProject", "x-since-version": "v0.287.0" }, "postgres_roles": { + "description": "The Postgres role definitions for the bundle, where each key is the name of the role. Each entry defines a role on a Lakebase Autoscaling branch, optionally backed by a Databricks identity.", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresRole", "x-since-version": "v1.4.0" }, @@ -6089,31 +6152,23 @@ "x-since-version": "v1.6.0" }, "deployments": { - "description": "[Private Preview] Deployment specs for this task. Exactly one deployment is currently\nsupported (a single entry where every node runs the same command); this\nis a current-Preview constraint. Role-split workloads (driver + worker,\nparameter server, separate eval node, etc.) with multiple entries are the\neventual intent but not yet supported.", + "description": "[Public Preview] Deployment specs for this task. Exactly one deployment is currently\nsupported (a single entry where every node runs the same command); this\nis a current-Preview constraint. Role-split workloads (driver + worker,\nparameter server, separate eval node, etc.) with multiple entries are the\neventual intent but not yet supported.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.DeploymentSpec", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" }, "experiment": { - "description": "[Private Preview] MLflow experiment name for this run. If an experiment with this name\nalready exists under the calling user, the run is appended to it;\notherwise a new experiment is created. To target a specific MLflow\nstorage location (for example, when running as a service principal), set\n`mlflow_experiment_directory`.", + "description": "[Public Preview] MLflow experiment name for this run. If an experiment with this name\nalready exists under the calling user, the run is appended to it;\notherwise a new experiment is created. To target a specific MLflow\nstorage location (for example, when running as a service principal), set\n`mlflow_experiment_directory`.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" }, "mlflow_experiment_directory": { - "description": "[Private Preview] Optional workspace directory under which the MLflow experiment named in\n`experiment` is created. Must start with `/Workspace`. Set this when\nrunning as a service principal that has no default user directory; for\nregular users the experiment defaults to the user's home directory.", + "description": "[Public Preview] Optional workspace directory under which the MLflow experiment named in\n`experiment` is created. Must start with `/Workspace`. Set this when\nrunning as a service principal that has no default user directory; for\nregular users the experiment defaults to the user's home directory.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" }, "mlflow_run": { - "description": "[Private Preview] Optional display name for the MLflow run created under `experiment`. If\nomitted, MLflow generates a default name.", + "description": "[Public Preview] Optional display name for the MLflow run created under `experiment`. If\nomitted, MLflow generates a default name.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" } }, @@ -6254,17 +6309,13 @@ "description": "ComputeSpec: compute configuration — accelerator type and total\naccelerator count across all nodes.", "properties": { "accelerator_count": { - "description": "[Private Preview] Total number of accelerators across all nodes. Must be a positive\nmultiple of the per-node accelerator count encoded in `accelerator_type`.\nFor example, `GPU_8xH100` with `accelerator_count: 16` allocates 2 nodes\n(8 GPUs per node).", + "description": "[Public Preview] Total number of accelerators across all nodes. Must be a positive\nmultiple of the per-node accelerator count encoded in `accelerator_type`.\nFor example, `GPU_8xH100` with `accelerator_count: 16` allocates 2 nodes\n(8 GPUs per node).", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" }, "accelerator_type": { - "description": "[Private Preview] Hardware accelerator type (for example, `GPU_1xA10` or `GPU_8xH100`).\nThe number of accelerators per node is encoded in the enum value —\n`GPU_8xH100` means 8 H100 GPUs per node.", + "description": "[Public Preview] Hardware accelerator type (for example, `GPU_1xA10` or `GPU_8xH100`).\nThe number of accelerators per node is encoded in the enum value —\n`GPU_8xH100` means 8 H100 GPUs per node.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpecAcceleratorType", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" } }, @@ -6283,9 +6334,9 @@ "GPU_8xH100" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "jobs.Condition": { @@ -6500,24 +6551,18 @@ "description": "DeploymentSpec: configuration for one deployment within an AiRuntimeTask.\nEach entry in `AiRuntimeTask.deployments` describes a group of nodes that\nshare the same command and compute. Many single-program training\nalgorithms use a single entry where every node runs the same command;\nrole-split workloads (driver + worker, parameter server, separate eval\nnode, etc.) use multiple entries.", "properties": { "command_path": { - "description": "[Private Preview] Workspace path of the script to run on each node in this deployment.\nUpload the script to this path and supply the path here. When the task\nruns, the file at this path is run on each node; if it fails, the task\nfails with its exit code.\n\nExample script contents:\n\n# Plain Python:\npython train.py --epochs 10\n\n# Multi-GPU via accelerate:\naccelerate launch train.py --config config.yaml\n\n# Distributed via torchrun:\ntorchrun --nproc_per_node=8 train.py", + "description": "[Public Preview] Workspace path of the script to run on each node in this deployment.\nUpload the script to this path and supply the path here. When the task\nruns, the file at this path is run on each node; if it fails, the task\nfails with its exit code.\n\nExample script contents:\n\n# Plain Python:\npython train.py --epochs 10\n\n# Multi-GPU via accelerate:\naccelerate launch train.py --config config.yaml\n\n# Distributed via torchrun:\ntorchrun --nproc_per_node=8 train.py", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" }, "compute": { - "description": "[Private Preview] Compute resources allocated to each node in this deployment.", + "description": "[Public Preview] Compute resources allocated to each node in this deployment.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpec", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" }, "name": { - "description": "[Private Preview] Optional human-readable name for this deployment (for example, `driver`,\n`worker`, `param_server`). Used for log and UI display. Distinct names\nare recommended so deployments can be told apart, but uniqueness is not\nenforced.", + "description": "[Public Preview] Optional human-readable name for this deployment (for example, `driver`,\n`worker`, `param_server`). Used for log and UI display. Distinct names\nare recommended so deployments can be told apart, but uniqueness is not\nenforced.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" } }, @@ -7856,10 +7901,8 @@ "type": "object", "properties": { "ai_runtime_task": { - "description": "[Private Preview] The task runs a multi-node GPU compute workload on Databricks AI Runtime.\nExternal-facing surface; mirrors the AIR CLI (fka SGCLI) v2 YAML schema.", + "description": "[Public Preview] The task runs a multi-gpu compute workload on Databricks AI Runtime. Specify\nthe accelerator type and count, the command to run, and where the workload's\ncode and MLflow output are stored.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiRuntimeTask", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.6.0" }, "alert_task": { @@ -10537,17 +10580,17 @@ "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]", + "description": "[Beta] Grants the Postgres `BYPASSRLS` attribute, which lets the role bypass every row-level security policy.", "$ref": "#/$defs/bool", "x-since-version": "v1.4.0" }, "createdb": { - "description": "[Beta]", + "description": "[Beta] Grants the Postgres `CREATEDB` attribute, which lets the role create databases.", "$ref": "#/$defs/bool", "x-since-version": "v1.4.0" }, "createrole": { - "description": "[Beta]", + "description": "[Beta] Grants the Postgres `CREATEROLE` attribute, which lets the role create, alter, and drop other roles.", "$ref": "#/$defs/bool", "x-since-version": "v1.4.0" } From 4599f12f5154dd26af2689bea27d1c06b2bb6c89 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 12 Aug 2026 14:00:45 +0000 Subject: [PATCH 17/31] Update jsonschema_for_docs.json for v1.12.0 --- bundle/schema/jsonschema_for_docs.json | 100 +++++++++++++++++++++---- 1 file changed, 84 insertions(+), 16 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 5c672837643..f40924c9583 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -16,6 +16,10 @@ "enum": [ "terraform", "direct" + ], + "enumDescriptions": [ + "Deploy through Terraform. Deprecated: Migrate to `direct`, see https://docs.databricks.com/aws/en/dev-tools/bundles/direct", + "Deploy by calling the Databricks APIs directly. This is the default." ] }, "resources.Alert": { @@ -1183,11 +1187,6 @@ "x-since-version": "v1.7.0", "deprecated": true }, - "idempotency_token": { - "description": "An optional token to guarantee the idempotency of job run requests. If a run with the provided token already exists,\nthe request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted,\nan error is returned.\n\nIf you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly one run\nis launched with that idempotency token.\n\nThis token must have at most 64 characters.\n\nFor more information, see [How to ensure idempotency for jobs](https://kb.databricks.com/jobs/jobs-idempotency.html).", - "$ref": "#/$defs/string", - "x-since-version": "v1.7.0" - }, "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", @@ -1590,6 +1589,11 @@ "$ref": "#/$defs/string", "x-since-version": "v0.230.0" }, + "cascade_on_destroy": { + "description": "Whether destroying the pipeline also deletes its datasets (MVs, STs, Views). Defaults to true (the server default). Set to false to retain the datasets when the pipeline is deleted. Only affects the delete operation.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.12.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", @@ -2444,6 +2448,64 @@ ], "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.Secret": { + "type": "object", + "description": "A secret stored in Unity Catalog. Secrets are three-level namespace objects\n(catalog.schema.secret) that securely store sensitive credential data such as\npasswords, tokens, and keys.", + "properties": { + "catalog_name": { + "description": "The name of the catalog where the schema and the secret reside.", + "$ref": "#/$defs/string", + "x-since-version": "v1.12.0" + }, + "comment": { + "description": "User-provided free-form text description of the secret.", + "$ref": "#/$defs/string", + "x-since-version": "v1.12.0" + }, + "expire_time": { + "description": "User-provided expiration time of the secret. Purely informational; does not trigger automatic actions.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", + "x-since-version": "v1.12.0" + }, + "grants": { + "description": "The grants to apply on this secret.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "x-since-version": "v1.12.0" + }, + "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.12.0" + }, + "name": { + "description": "The name of the secret, relative to its parent schema.", + "$ref": "#/$defs/string", + "x-since-version": "v1.12.0" + }, + "owner": { + "description": "The owner of the secret. Defaults to the creating principal on creation. Can be updated to\ntransfer ownership of the secret to another principal.", + "$ref": "#/$defs/string", + "x-since-version": "v1.12.0" + }, + "schema_name": { + "description": "The name of the schema where the secret resides.", + "$ref": "#/$defs/string", + "x-since-version": "v1.12.0" + }, + "value": { + "description": "The secret value to store. Must be a variable reference (e.g. ${var.my_secret}) to prevent plain-text secrets in configuration files.", + "$ref": "#/$defs/string", + "x-since-version": "v1.12.0" + } + }, + "additionalProperties": false, + "required": [ + "catalog_name", + "name", + "schema_name", + "value" + ] + }, "resources.SecretScope": { "type": "object", "properties": { @@ -3053,7 +3115,7 @@ "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\".", + "description": "The deployment engine to use. Valid values are `terraform` and `direct`. Takes priority over `DATABRICKS_BUNDLE_ENGINE` environment variable. Default is \"direct\".", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/engine.EngineType", "x-since-version": "v0.295.0" }, @@ -3319,7 +3381,7 @@ "x-since-version": "v1.9.0" }, "job_runs": { - "description": "The job run definitions for the bundle, where each key is the name of the job run. Each job run triggers a run of an existing job as part of bundle deployment.", + "description": "The job run definitions for the bundle, where each key is the name of the job run. Each job run triggers a run of an existing job as part of bundle deployment.\n\nThe deployment waits for the run to finish and fails if it does not succeed, so other resources can reference the run's outcome, for example `${resources.job_runs.\u003cname\u003e.state.result_state}`. A run that did not succeed is run again on the next deployment.", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.JobRun", "x-since-version": "v1.7.0" }, @@ -3406,6 +3468,12 @@ "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" }, + "secrets": { + "description": "The Unity Catalog secret definitions for the bundle, where each key is the name of the secret.", + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Secret", + "markdownDescription": "The Unity Catalog secret definitions for the bundle, where each key is the name of the secret. See [secrets](https://docs.databricks.com/dev-tools/bundles/resources.html#secrets).", + "x-since-version": "v1.12.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", @@ -9064,17 +9132,13 @@ "description": "Fanout configuration for multi-table routing from streaming sources.\nRoutes each input record to a destination table based on a routing\nkey derived from the record. The key value becomes the table name\nsuffix: {destination_catalog}.{destination_schema}.{key_value}.", "properties": { "fanout_by": { - "description": "[Private Preview] Column path or SQL expression whose value determines the destination table.\nSupports dotted paths (e.g. \"value.event_name\") and expressions\n(e.g. \"value:event_name::string\").", + "description": "[Beta] Column path or SQL expression whose value determines the destination table.\nSupports dotted paths (e.g. \"value.event_name\") and expressions\n(e.g. \"value:event_name::string\").", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.10.0" }, "transforms": { - "description": "[Private Preview] Optional transforms applied to each route's DataFrame before writing\nto the destination table.", + "description": "[Beta] Optional transforms applied to each route's DataFrame before writing\nto the destination table.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.10.0" } }, @@ -9997,10 +10061,8 @@ "x-since-version": "v0.229.0" }, "fanout_options": { - "description": "[Private Preview] Fanout options for multi-table routing from streaming sources.\nWhen set, records are routed to destination tables based on a\nper-record routing key. The key value becomes the table name:\n{destination_catalog}.{destination_schema}.{key_value}.", + "description": "[Beta] Fanout options for multi-table routing from streaming sources.\nWhen set, records are routed to destination tables based on a\nper-record routing key. The key value becomes the table name:\n{destination_catalog}.{destination_schema}.{key_value}.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionFanoutOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.10.0" }, "source_catalog": { @@ -12471,6 +12533,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Schema" } }, + "resources.Secret": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Secret" + } + }, "resources.SecretScope": { "type": "object", "additionalProperties": { From c33eefdb98cf2aab92c8d70692c220ffd39f988b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 20 Aug 2026 13:40:12 +0000 Subject: [PATCH 18/31] Update jsonschema_for_docs.json for v1.13.0 --- bundle/schema/jsonschema_for_docs.json | 225 +++++++++++++++++++++++-- 1 file changed, 214 insertions(+), 11 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index f40924c9583..f374c99ca90 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -142,6 +142,13 @@ "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, + "forward_user_access_token": { + "description": "[Private Preview] Forward the user's access token to the app. Requires stopping and starting app compute to take effect.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.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", @@ -1130,6 +1137,11 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TriggerSettings", "x-since-version": "v0.229.0" }, + "triggers": { + "description": "[Beta] List of triggers attached to this job. A run starts when any active trigger evaluates to true. Cannot be set in\nthe same request as the legacy `schedule`, `trigger`, or `continuous` fields. The 10-trigger cap is the design's\nhard limit; rollout steps the effective cap 3 -\u003e 5 -\u003e 10 via internal validation during the preview.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.TriggerConfiguration", + "x-since-version": "v1.13.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", @@ -1207,8 +1219,8 @@ "x-since-version": "v1.7.0" }, "lifecycle": { - "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed and when the run re-fires.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.JobRunLifecycle", "x-since-version": "v1.7.0" }, "notebook_params": { @@ -1282,6 +1294,33 @@ "job_id" ] }, + "resources.JobRunLifecycle": { + "type": "object", + "properties": { + "prevent_destroy": { + "description": "Lifecycle setting to prevent the resource from being destroyed.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.13.0" + }, + "triggers": { + "description": "Conditions that re-fire this job run (in addition to configuration changes).", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.JobRunTrigger", + "x-since-version": "v1.13.0" + } + }, + "additionalProperties": false + }, + "resources.JobRunTrigger": { + "type": "object", + "properties": { + "on_bundle_deploy": { + "description": "If true, re-fire the run on every bundle deploy. Incompatible with lifecycle.prevent_destroy.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.13.0" + } + }, + "additionalProperties": false + }, "resources.Lifecycle": { "type": "object", "properties": { @@ -5356,7 +5395,7 @@ "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`.", + "description": "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" } @@ -6224,11 +6263,23 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.DeploymentSpec", "x-since-version": "v1.6.0" }, + "docker_image_url": { + "description": "[Beta] Optional Docker image URL for a custom container image. When set,\nthe task runs on the specified container image instead of the default\nDatabricks client image. Format:\n`{organization}/{repository}:{tag}`", + "$ref": "#/$defs/string", + "x-since-version": "v1.13.0" + }, "experiment": { "description": "[Public Preview] MLflow experiment name for this run. If an experiment with this name\nalready exists under the calling user, the run is appended to it;\notherwise a new experiment is created. To target a specific MLflow\nstorage location (for example, when running as a service principal), set\n`mlflow_experiment_directory`.", "$ref": "#/$defs/string", "x-since-version": "v1.6.0" }, + "mlflow_artifact_location": { + "description": "[Private Preview] Optional root location for MLflow artifacts logged by the run.\nIf this field isn't specified the default artifact location will be in dbfs\ni.e. `dbfs:/databricks/mlflow-tracking/\u003cexperiment_id\u003e/...`\nIf dbfs access is restricted or UC is preferred this can be a custom location in UC:\n`dbfs:/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/...`\nThe location should be unique for each experiment.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.0" + }, "mlflow_experiment_directory": { "description": "[Public Preview] Optional workspace directory under which the MLflow experiment named in\n`experiment` is created. Must start with `/Workspace`. Set this when\nrunning as a service principal that has no default user directory; for\nregular users the experiment defaults to the user's home directory.", "$ref": "#/$defs/string", @@ -6468,6 +6519,18 @@ }, "additionalProperties": false }, + "jobs.ContinuousTriggerConfiguration": { + "type": "object", + "description": "Continuous trigger. Stripped-down counterpart to `ContinuousSettings`: `pause_status` is owned by the enclosing\n`TriggerConfiguration` and intentionally omitted here.", + "properties": { + "task_retry_mode": { + "description": "[Beta] Whether the continuous job applies task-level retries. Defaults to NEVER.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskRetryMode", + "x-since-version": "v1.13.0" + } + }, + "additionalProperties": false + }, "jobs.CronSchedule": { "type": "object", "properties": { @@ -6500,6 +6563,27 @@ "timezone_id" ] }, + "jobs.CronTriggerConfiguration": { + "type": "object", + "description": "Cron schedule trigger. Stripped-down counterpart to `CronSchedule`: `pause_status` and `sql_condition` are owned\nby the enclosing `TriggerConfiguration` and intentionally omitted here.", + "properties": { + "quartz_cron_expression": { + "description": "[Beta] A Cron expression using Quartz syntax that describes the schedule for this trigger. See\n[Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details.", + "$ref": "#/$defs/string", + "x-since-version": "v1.13.0" + }, + "timezone_id": { + "description": "[Beta] A Java timezone ID. The schedule is resolved with respect to this timezone. See\n[Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details.", + "$ref": "#/$defs/string", + "x-since-version": "v1.13.0" + } + }, + "additionalProperties": false, + "required": [ + "quartz_cron_expression", + "timezone_id" + ] + }, "jobs.DashboardTask": { "type": "object", "description": "Configures the Lakeview Dashboard job task type.", @@ -8272,6 +8356,57 @@ "ON_FAILURE" ] }, + "jobs.TriggerConfiguration": { + "type": "object", + "description": "A single trigger attached to a job via `JobSettings.triggers`. Exactly one of the trigger-type fields\n(`periodic`, `schedule`, `continuous`, `file_arrival`, `table_update`, `model`) must be set; mutual exclusivity\nis enforced in the API handler rather than via `oneof` so that codegen, validation, and JSON serialization\nacross SDKs and Terraform behave consistently.", + "properties": { + "continuous": { + "description": "[Beta] Continuous trigger configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ContinuousTriggerConfiguration", + "x-since-version": "v1.13.0" + }, + "file_arrival": { + "description": "[Beta] File arrival trigger configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration", + "x-since-version": "v1.13.0" + }, + "model": { + "description": "[Private Preview] Model trigger configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.0" + }, + "pause_status": { + "description": "[Beta] Whether this trigger is paused. Defaults to UNPAUSED when unset; the server always returns an explicit value on read.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", + "x-since-version": "v1.13.0" + }, + "periodic": { + "description": "[Beta] Trigger type: exactly one must be set; mutual exclusivity is enforced in the API handler\nPeriodic trigger configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration", + "x-since-version": "v1.13.0" + }, + "schedule": { + "description": "[Beta] Cron schedule trigger configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CronTriggerConfiguration", + "x-since-version": "v1.13.0" + }, + "sql_condition": { + "description": "[Private Preview] Optional SQL condition that gates whether this trigger fires.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlConditionConfiguration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.0" + }, + "table_update": { + "description": "[Beta] Table update trigger configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration", + "x-since-version": "v1.13.0" + } + }, + "additionalProperties": false + }, "jobs.TriggerSettings": { "type": "object", "properties": { @@ -8455,6 +8590,34 @@ "schema" ] }, + "pipelines.ApiSourceConnectorConfig": { + "type": "object", + "description": "Top-level configuration for API Source connectors with arbitrary configuration.", + "properties": { + "configs": { + "description": "[Private Preview] Arbitrary key-value configuration values for the API Source connector.", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.0" + } + }, + "additionalProperties": false + }, + "pipelines.ApiSourceConnectorOptions": { + "type": "object", + "description": "Options for API Source connectors with arbitrary configuration.", + "properties": { + "options": { + "description": "[Private Preview] Arbitrary key-value configuration options for the API Source connector.", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.0" + } + }, + "additionalProperties": false + }, "pipelines.AutoFullRefreshPolicy": { "type": "object", "description": "Policy for auto full refresh.", @@ -8504,6 +8667,13 @@ "type": "object", "description": "Wrapper message for source-specific options to support multiple connector types", "properties": { + "api_source_connector_options": { + "description": "[Private Preview] Connector-specific options for API Source connectors.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ApiSourceConnectorOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.0" + }, "confluence_options": { "description": "[Public Preview] Confluence specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions", @@ -8574,10 +8744,8 @@ "x-since-version": "v0.298.0" }, "zendesk_support_options": { - "description": "[Private Preview] Zendesk Support specific options for ingestion", + "description": "[Beta] 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" } }, @@ -9260,7 +9428,7 @@ "[Beta]", "[Public Preview]", "[Beta]", - "[Private Preview]", + "[Beta]", "[Private Preview]" ] }, @@ -10164,6 +10332,13 @@ "pipelines.SourceConfig": { "type": "object", "properties": { + "api_source_connector_config": { + "description": "[Private Preview] Connector-specific top-level configuration for API Source connectors.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ApiSourceConnectorConfig", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.0" + }, "catalog": { "description": "[Public Preview] Catalog-level source configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig", @@ -10486,10 +10661,24 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", "x-since-version": "v1.1.0" }, + "input_column": { + "description": "[Private Preview] Optional input column to transform. When set, the transformer reads\nfrom this column instead of the default source column.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.0" + }, "json_options": { "description": "[Beta]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", "x-since-version": "v1.1.0" + }, + "output_column": { + "description": "[Private Preview] Optional output column name. When set, the transformed result is\nwritten to this column instead of replacing the input column.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.13.0" } }, "additionalProperties": false @@ -10510,10 +10699,8 @@ "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.", + "description": "[Beta] (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" } }, @@ -11739,6 +11926,7 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "CPU_LARGE", + "GPU_XLARGE_8", "GPU_XLARGE", "CPU_MEDIUM" ], @@ -11750,6 +11938,7 @@ "", "[Beta]", "[Beta]", + "[Beta]", "[Beta]" ] }, @@ -11772,6 +11961,7 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "CPU_LARGE", + "GPU_XLARGE_8", "GPU_XLARGE", "CPU_MEDIUM" ], @@ -11783,6 +11973,7 @@ "", "[Beta]", "[Beta]", + "[Beta]", "[Beta]" ] }, @@ -11795,7 +11986,7 @@ "x-since-version": "v1.6.0" }, "table_names": { - "description": "[Public Preview] The Unity Catalog tables to which endpoint telemetry (logs, traces, and metrics) is exported.\nProvide this to create a new telemetry profile for the endpoint from the given tables.", + "description": "[Public Preview] The Unity Catalog tables to which endpoint telemetry (logs, traces, and metrics) is exported.\nProvide this to create a new telemetry profile for the endpoint from the given tables.\nThis field selects the tables when writing a telemetry configuration; it is not returned when\nreading one. Responses identify the resulting profile with `telemetry_profile_id` instead.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.UnityCatalogTableNames", "x-since-version": "v1.10.0" }, @@ -12659,6 +12850,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.JobPermission" } }, + "resources.JobRunTrigger": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.JobRunTrigger" + } + }, "resources.MlflowExperimentPermission": { "type": "array", "items": { @@ -12868,6 +13065,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskDependency" } }, + "jobs.TriggerConfiguration": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TriggerConfiguration" + } + }, "jobs.Webhook": { "type": "array", "items": { From 7c9ca6f0ae61dd8287b3fc510c85d8a416594707 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 26 Aug 2026 12:31:42 +0000 Subject: [PATCH 19/31] Update jsonschema_for_docs.json for v1.14.0 --- bundle/schema/jsonschema_for_docs.json | 416 +++++++++++++++++++++---- 1 file changed, 349 insertions(+), 67 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index f374c99ca90..0b51a2c7fc3 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -155,7 +155,7 @@ "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.", + "description": "[Beta] 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" }, @@ -181,6 +181,7 @@ "x-since-version": "v0.239.0" }, "source_code_path": { + "description": "[Beta]", "$ref": "#/$defs/string", "x-since-version": "v0.239.0" }, @@ -569,6 +570,86 @@ "level" ] }, + "resources.ClusterPolicy": { + "type": "object", + "properties": { + "definition": { + "description": "Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).", + "$ref": "#/$defs/interface", + "x-since-version": "v1.14.0" + }, + "description": { + "description": "Additional human-readable description of the cluster policy.", + "$ref": "#/$defs/string", + "x-since-version": "v1.14.0" + }, + "libraries": { + "description": "A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.Library", + "x-since-version": "v1.14.0" + }, + "lifecycle": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.14.0" + }, + "max_clusters_per_user": { + "description": "Max number of clusters per user that can be active using this policy. If not present, there is no max limit.", + "$ref": "#/$defs/int64", + "x-since-version": "v1.14.0" + }, + "name": { + "description": "Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100\ncharacters.", + "$ref": "#/$defs/string", + "x-since-version": "v1.14.0" + }, + "permissions": { + "description": "The permissions to apply to this resource.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.ClusterPolicyPermission", + "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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": "v1.14.0" + }, + "policy_family_definition_overrides": { + "description": "Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).\nThe JSON document must be passed as a string and cannot be embedded in the requests.\n\nYou can use this to customize the policy definition inherited from the policy family.\nPolicy rules specified here are merged into the inherited policy definition.", + "$ref": "#/$defs/interface", + "x-since-version": "v1.14.0" + }, + "policy_family_id": { + "description": "ID of the policy family. The cluster policy's policy definition inherits the policy\nfamily's policy definition.\n\nCannot be used with `definition`. Use `policy_family_definition_overrides` instead to\ncustomize the policy definition.", + "$ref": "#/$defs/string", + "x-since-version": "v1.14.0" + } + }, + "additionalProperties": false + }, + "resources.ClusterPolicyPermission": { + "type": "object", + "properties": { + "group_name": { + "description": "The name of the group granted the permission level.", + "$ref": "#/$defs/string", + "x-since-version": "v1.14.0" + }, + "level": { + "description": "The permission level to apply. Cluster policies only support `CAN_USE`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterPolicyPermissionLevel", + "x-since-version": "v1.14.0" + }, + "service_principal_name": { + "description": "The name of the service principal granted the permission level.", + "$ref": "#/$defs/string", + "x-since-version": "v1.14.0" + }, + "user_name": { + "description": "The name of the user granted the permission level.", + "$ref": "#/$defs/string", + "x-since-version": "v1.14.0" + } + }, + "additionalProperties": false, + "required": [ + "level" + ] + }, "resources.Dashboard": { "type": "object", "properties": { @@ -1138,7 +1219,7 @@ "x-since-version": "v0.229.0" }, "triggers": { - "description": "[Beta] List of triggers attached to this job. A run starts when any active trigger evaluates to true. Cannot be set in\nthe same request as the legacy `schedule`, `trigger`, or `continuous` fields. The 10-trigger cap is the design's\nhard limit; rollout steps the effective cap 3 -\u003e 5 -\u003e 10 via internal validation during the preview.", + "description": "[Beta] List of triggers attached to this job. A run starts when any active trigger evaluates to true. Cannot be set in\nthe same request as the legacy `schedule`, `trigger`, or `continuous` fields. Gated behind the \"Multiple Triggers\" feature preview.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.TriggerConfiguration", "x-since-version": "v1.13.0" }, @@ -3379,6 +3460,10 @@ "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Catalog", "x-since-version": "v0.287.0" }, + "cluster_policies": { + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ClusterPolicy", + "x-since-version": "v1.14.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", @@ -4270,6 +4355,16 @@ "type": "object", "description": "Git repository configuration specifying the location of the repository.", "properties": { + "auto_deploy": { + "description": "[Beta] When true, automatically deploys the app on push events to the branch configured in\nthe app's deployment_source.git_source.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.14.0" + }, + "caller_credential_id": { + "description": "[Beta] ID of a personal access token Git credential owned by the caller, used to\ngrant the app's service principal access to this repository.", + "$ref": "#/$defs/int64", + "x-since-version": "v1.14.0" + }, "provider": { "description": "Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud,\nbitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.", "$ref": "#/$defs/string", @@ -5012,6 +5107,13 @@ "CAN_ATTACH_TO" ] }, + "compute.ClusterPolicyPermissionLevel": { + "type": "string", + "description": "Permission level", + "enum": [ + "CAN_USE" + ] + }, "compute.ClusterSpec": { "type": "object", "description": "Contains a snapshot of the latest user specified settings that were used to create/edit the cluster.", @@ -6099,9 +6201,13 @@ "type": "string", "description": "PostgreSQL-specific target types that can override the default Delta-to-PG mapping.", "enum": [ - "PG_SPECIFIC_TYPE_VECTOR" + "PG_SPECIFIC_TYPE_VECTOR", + "PG_SPECIFIC_TYPE_HALFVEC", + "PG_SPECIFIC_TYPE_VARCHAR" ], "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", "[Private Preview]" ] }, @@ -6934,8 +7040,7 @@ }, "additionalProperties": false, "required": [ - "job_cluster_key", - "new_cluster" + "job_cluster_key" ] }, "jobs.JobDeployment": { @@ -8703,6 +8808,20 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", "x-since-version": "v1.1.0" }, + "linkedin_ads_options": { + "description": "[Private Preview] LinkedIn Ads specific options for ingestion.\nsync_start_date and lookback_window_days apply to both the prebuilt analytics\ntables and custom reports. custom_report_options defines a custom (user-defined)\nadAnalytics report and is only valid on a table object.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.LinkedInAdsOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.0" + }, + "marketo_options": { + "description": "[Private Preview] Marketo specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MarketoOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.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", @@ -8744,7 +8863,7 @@ "x-since-version": "v0.298.0" }, "zendesk_support_options": { - "description": "[Beta] Zendesk Support specific options for ingestion", + "description": "[Public Preview] Zendesk Support specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", "x-since-version": "v0.299.2" } @@ -8759,8 +8878,8 @@ "QUERY_BASED" ], "enumDescriptions": [ - "[Beta]", - "[Beta]" + "[Public Preview]", + "[Public Preview]" ] }, "pipelines.CronTrigger": { @@ -8782,17 +8901,17 @@ "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.", + "description": "[Public Preview] (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.", + "description": "[Public Preview] (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", + "description": "[Public Preview] (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" } @@ -9246,12 +9365,12 @@ "x-since-version": "v0.229.0" }, "connector_type": { - "description": "[Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based.", + "description": "[Public Preview] (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.", + "description": "[Public Preview] (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" }, @@ -9428,7 +9547,7 @@ "[Beta]", "[Public Preview]", "[Beta]", - "[Beta]", + "[Public Preview]", "[Private Preview]" ] }, @@ -9520,10 +9639,134 @@ }, "additionalProperties": false }, + "pipelines.LinkedInAdsOptions": { + "type": "object", + "description": "LinkedIn Ads specific options for ingestion.\nsync_start_date and lookback_window_days apply to both the prebuilt analytics\ntables and custom reports. custom_report_options defines a custom (user-defined)\nadAnalytics report and is only valid on a table object.", + "properties": { + "custom_report_options": { + "description": "[Private Preview] (Optional) Custom report definition. Only valid on a table object. When set,\nthe table is synthesized from /rest/adAnalytics using the finder, pivots,\ntime granularity and metrics here. When unset, the table must match one of\nthe connector's prebuilt sources.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.0" + }, + "lookback_window_days": { + "description": "[Private Preview] (Optional) Days to look back during incremental sync for late-arriving data.\nIf not specified, defaults to 30 days.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.0" + }, + "sync_start_date": { + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables, YYYY-MM-DD.\nEarliest date from which to sync historical data; overrides the default\nwhen set. For finder attributedRevenueMetrics, this must be between 30 and\n366 days before today.\nIf not specified, defaults to 1 year of history.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.0" + } + }, + "additionalProperties": false + }, + "pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptions": { + "type": "object", + "description": "User-defined custom report for the LinkedIn Ads connector. The destination\ntable name comes from the enclosing TableSpec.destination_table, the start\ndate from the enclosing LinkedInAdsOptions.sync_start_date, and the account\nit runs against from the source schema (namespace) -- none are repeated here.", + "properties": { + "entity_granularity": { + "description": "[Private Preview] (Required) Entity pivots to group by; count/constraints depend on finder.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptionsLinkedInAdsEntityGranularity", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.0" + }, + "finder": { + "description": "[Private Preview] (Required) adAnalytics finder. See LinkedInAdsFinder.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptionsLinkedInAdsFinder", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.0" + }, + "metrics": { + "description": "[Private Preview] (Optional) LinkedIn metric names for the report. Open vocabulary (not an\nenum): the valid set is large (~100) and evolves with the LinkedIn\nadAnalytics API, so values are passed through verbatim. If empty, a\npivot-safe default core set is ingested: impressions, clicks,\ncostInLocalCurrency, externalWebsiteConversions (valid for every pivot).\nIgnored for attributedRevenueMetrics (always returns the full\nRevenueAttributionMetrics struct).", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.0" + }, + "time_granularity": { + "description": "[Private Preview] (Optional) Time aggregation. Defaults to DAILY when unspecified. Used by\nanalytics/statistics; ignored for attributedRevenueMetrics.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptionsLinkedInAdsTimeGranularity", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.0" + } + }, + "additionalProperties": false, + "required": [ + "finder" + ] + }, + "pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptionsLinkedInAdsEntityGranularity": { + "type": "string", + "description": "Entity pivot to group by.", + "enum": [ + "CAMPAIGN", + "CREATIVE", + "CAMPAIGN_GROUP" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, + "pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptionsLinkedInAdsFinder": { + "type": "string", + "description": "adAnalytics finder. Determines call shape, valid pivots, and metric\nrequirements.", + "enum": [ + "ANALYTICS", + "STATISTICS", + "ATTRIBUTED_REVENUE_METRICS" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, + "pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptionsLinkedInAdsTimeGranularity": { + "type": "string", + "description": "Time aggregation. Used by analytics/statistics; ignored for\nattributedRevenueMetrics. Defaults to DAILY when unspecified.", + "enum": [ + "ALL", + "DAILY", + "MONTHLY", + "YEARLY" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, "pipelines.ManualTrigger": { "type": "object", "additionalProperties": false }, + "pipelines.MarketoOptions": { + "type": "object", + "description": "Marketo specific options for ingestion", + "properties": { + "sync_start_date": { + "description": "[Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format.\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": "v1.14.0" + } + }, + "additionalProperties": false + }, "pipelines.MetaMarketingOptions": { "type": "object", "description": "Meta Marketing (Meta Ads) specific options for ingestion", @@ -10239,7 +10482,7 @@ "x-since-version": "v0.229.0" }, "source_schema": { - "description": "[Public Preview] Required. Schema name in the source database.", + "description": "[Public Preview] Schema name in the source database. Currently required; this field will become optional in\nan upcoming release, since some source types (for example streaming / message-bus connectors)\ndo not use it. When that change ships, this field's type in the generated SDKs and CLI will\nchange from required to optional (nullable); clients that assume it is always present should\nhandle its absence.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, @@ -10388,7 +10631,7 @@ "x-since-version": "v0.229.0" }, "source_table": { - "description": "[Public Preview] Required. Table name in the source database.", + "description": "[Public Preview] Table name in the source database. Currently required; this field will become optional in\nan upcoming release, since some source types (for example streaming / message-bus connectors)\ndo not use it. When that change ships, this field's type in the generated SDKs and CLI will\nchange from required to optional (nullable); clients that assume it is always present should\nhandle its absence.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, @@ -10466,10 +10709,8 @@ "x-since-version": "v0.231.0" }, "source_metadata_column": { - "description": "[Private Preview] (Optional) Name of the struct column added to each ingested record to hold per row source\nmetadata.", + "description": "[Beta] (Optional) Name of the struct column added to each ingested record to hold per row source\nmetadata.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, "x-since-version": "v1.9.0" }, "table_properties": { @@ -10699,7 +10940,7 @@ "description": "Zendesk Support specific options for ingestion", "properties": { "start_date": { - "description": "[Beta] (Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", + "description": "[Public 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-since-version": "v0.299.2" } @@ -10710,17 +10951,17 @@ "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.", + "description": "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.", + "description": "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.", + "description": "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" } @@ -10736,7 +10977,7 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "pg_settings": { - "description": "[Beta] A raw representation of Postgres settings.", + "description": "A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", "x-since-version": "v0.287.0" } @@ -10749,43 +10990,58 @@ "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.", + "description": "Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, + "pipeline_channel": { + "description": "[Private Preview] Release channel of the underlying pipeline's runtime.\nSome source table configurations (e.g., read-time CDF) require PREVIEW.\nDefaults to CURRENT if not specified.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.NewPipelineSpecPipelineChannel", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.14.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.", + "description": "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.", + "description": "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.NewPipelineSpecPipelineChannel": { + "type": "string", + "description": "Release channel of the underlying pipeline's runtime.\nPREVIEW provides early access to the latest features but may be less stable.\nSome source table configurations (e.g., read-time CDF) require PREVIEW.\nDefaults to CURRENT if not specified.", + "enum": [ + "CURRENT", + "PREVIEW" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" + ] + }, "postgres.ProjectCustomTag": { "type": "object", "properties": { "key": { - "description": "[Beta] The key of the custom tag.", + "description": "The key of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.290.0" }, "value": { - "description": "[Beta] The value of the custom tag.", + "description": "The value of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.290.0" } @@ -10797,27 +11053,27 @@ "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.", + "description": "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.", + "description": "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.", + "description": "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.", + "description": "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.", + "description": "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" } @@ -10829,17 +11085,17 @@ "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] Grants the Postgres `BYPASSRLS` attribute, which lets the role bypass every row-level security policy.", + "description": "Grants the Postgres `BYPASSRLS` attribute, which lets the role bypass every row-level security policy.", "$ref": "#/$defs/bool", "x-since-version": "v1.4.0" }, "createdb": { - "description": "[Beta] Grants the Postgres `CREATEDB` attribute, which lets the role create databases.", + "description": "Grants the Postgres `CREATEDB` attribute, which lets the role create databases.", "$ref": "#/$defs/bool", "x-since-version": "v1.4.0" }, "createrole": { - "description": "[Beta] Grants the Postgres `CREATEROLE` attribute, which lets the role create, alter, and drop other roles.", + "description": "Grants the Postgres `CREATEROLE` attribute, which lets the role create, alter, and drop other roles.", "$ref": "#/$defs/bool", "x-since-version": "v1.4.0" } @@ -10853,11 +11109,6 @@ "NO_LOGIN", "PG_PASSWORD_SCRAM_SHA_256", "LAKEBASE_OAUTH_V1" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]" ] }, "postgres.RoleIdentityType": { @@ -10867,11 +11118,6 @@ "USER", "SERVICE_PRINCIPAL", "GROUP" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]" ] }, "postgres.RoleMembershipRole": { @@ -10879,9 +11125,6 @@ "description": "Roles that the DatabaseInstanceRole can be a member of.", "enum": [ "DATABRICKS_SUPERUSER" - ], - "enumDescriptions": [ - "[Beta]" ] }, "postgres.SyncedTableSyncedTableSpecExtraColumn": { @@ -10937,10 +11180,9 @@ "type": "string", "description": "PostgreSQL-specific target types that can override the default Delta-to-PG mapping.", "enum": [ - "PG_SPECIFIC_TYPE_VECTOR" - ], - "enumDescriptions": [ - "[Beta]" + "PG_SPECIFIC_TYPE_VECTOR", + "PG_SPECIFIC_TYPE_HALFVEC", + "PG_SPECIFIC_TYPE_VARCHAR" ] }, "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy": { @@ -10950,11 +11192,6 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]" ] }, "postgres.SyncedTableSyncedTableSpecTypeOverride": { @@ -10962,17 +11199,17 @@ "description": "Overrides the default Delta-to-PostgreSQL type mapping for a single column.", "properties": { "column_name": { - "description": "[Beta] Name of the source column whose target PostgreSQL type should be overridden.", + "description": "Name of the source column whose target PostgreSQL type should be overridden.", "$ref": "#/$defs/string", "x-since-version": "v1.5.0" }, "pg_type": { - "description": "[Beta] PostgreSQL-specific target type to use for the column.", + "description": "PostgreSQL-specific target type to use for the column.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecPgSpecificType", "x-since-version": "v1.5.0" }, "size": { - "description": "[Beta] Size parameter for the target type, for types that take one (e.g. vector\ndimension, varchar length). Required when the chosen pg_type needs a size.", + "description": "Size parameter for the target type, for types that take one (e.g. vector\ndimension, varchar length). Required when the chosen pg_type needs a size.", "$ref": "#/$defs/int", "x-since-version": "v1.5.0" } @@ -11980,13 +12217,18 @@ "serving.TelemetryConfig": { "type": "object", "properties": { + "enabled_telemetry_features": { + "description": "[Public Preview] The telemetry signals to enable for this endpoint. If empty or omitted, all signals are\nenabled; otherwise only the listed signals are enabled.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.TelemetryFeature", + "x-since-version": "v1.14.0" + }, "inference_table_config": { "description": "[Public Preview] Configuration for inference table payload logging, including sampling.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TelemetryInferenceTableConfig", "x-since-version": "v1.6.0" }, "table_names": { - "description": "[Public Preview] The Unity Catalog tables to which endpoint telemetry (logs, traces, and metrics) is exported.\nProvide this to create a new telemetry profile for the endpoint from the given tables.\nThis field selects the tables when writing a telemetry configuration; it is not returned when\nreading one. Responses identify the resulting profile with `telemetry_profile_id` instead.", + "description": "[Public Preview] The Unity Catalog tables to which endpoint telemetry (logs, traces, and metrics) is exported.\nProvide this to create a new telemetry profile for the endpoint from the given tables.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.UnityCatalogTableNames", "x-since-version": "v1.10.0" }, @@ -11998,6 +12240,22 @@ }, "additionalProperties": false }, + "serving.TelemetryFeature": { + "type": "string", + "description": "A telemetry signal that a serving endpoint can export to Unity Catalog. Use these values to\nselect which signals the endpoint exports.", + "enum": [ + "TELEMETRY_FEATURE_LOGS", + "TELEMETRY_FEATURE_TRACES", + "TELEMETRY_FEATURE_METRICS", + "TELEMETRY_FEATURE_INFERENCE_TABLE" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" + ] + }, "serving.TelemetryInferenceTableConfig": { "type": "object", "description": "Inference table payload logging configuration", @@ -12592,6 +12850,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Cluster" } }, + "resources.ClusterPolicy": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ClusterPolicy" + } + }, "resources.Dashboard": { "type": "object", "additionalProperties": { @@ -12838,6 +13102,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ClusterPermission" } }, + "resources.ClusterPolicyPermission": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ClusterPolicyPermission" + } + }, "resources.InstancePoolPermission": { "type": "array", "items": { @@ -13113,6 +13383,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue" } }, + "pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptionsLinkedInAdsEntityGranularity": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.LinkedInAdsOptionsLinkedInAdsCustomReportOptionsLinkedInAdsEntityGranularity" + } + }, "pipelines.Notifications": { "type": "array", "items": { @@ -13203,6 +13479,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput" } }, + "serving.TelemetryFeature": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TelemetryFeature" + } + }, "sql.AlertStatementParameter": { "type": "array", "items": { From 6277aec008ebdc7739200ef0996fb4fe5b4d71bc Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 3 Sep 2026 09:23:03 +0000 Subject: [PATCH 20/31] Update jsonschema_for_docs.json for v1.15.0 --- bundle/schema/jsonschema_for_docs.json | 30 ++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 0b51a2c7fc3..8f8eb38b8ca 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -3177,15 +3177,25 @@ "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config.ArtifactFile", "x-since-version": "v0.229.0" }, + "git": { + "description": "For a `tgz` artifact, snapshot this git ref instead of the working tree. Mutually exclusive with `build`.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config.ArtifactGit", + "x-since-version": "v1.15.0" + }, + "include": { + "description": "For a `tgz` artifact, subpaths of `path` to pack, relative to it; empty packs the whole `path`. `.gitignore` is honored; the bundle-wide sync include/exclude do not apply. Archive entries are named relative to `path`. Mutually exclusive with `build`.", + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.15.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`.", + "description": "The type of the artifact. Valid values are `whl`, `jar`, and `tgz`. Required if the artifact is a Python wheel.", "$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`.", + "markdownDescription": "The type of the artifact. Valid values are `whl`, `jar`, and `tgz`. Required if the artifact is a Python wheel.", "x-since-version": "v0.229.0" } }, @@ -3205,6 +3215,22 @@ "source" ] }, + "config.ArtifactGit": { + "type": "object", + "properties": { + "branch": { + "description": "The git branch to snapshot.", + "$ref": "#/$defs/string", + "x-since-version": "v1.15.0" + }, + "commit": { + "description": "The git commit to snapshot. Takes precedence over `branch` when both are set.", + "$ref": "#/$defs/string", + "x-since-version": "v1.15.0" + } + }, + "additionalProperties": false + }, "config.ArtifactType": { "type": "string" }, From 85d8a317c8060651deb6e263af34348bf64abf99 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 9 Sep 2026 13:40:29 +0000 Subject: [PATCH 21/31] Update jsonschema_for_docs.json for v1.16.0 --- bundle/schema/jsonschema_for_docs.json | 1474 +++++++++++++++++++++++- 1 file changed, 1442 insertions(+), 32 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 8f8eb38b8ca..9ee28de6fba 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -28,20 +28,24 @@ "custom_description": { "description": "Custom description for the alert. support mustache template.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "custom_summary": { "description": "Custom summary for the alert. support mustache template.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "display_name": { "description": "The display name of the alert.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "evaluation": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "file_path": { @@ -54,7 +58,7 @@ "x-since-version": "v0.279.0" }, "parameters": { - "description": "[Private Preview] Query parameters bound when executing the alert query, referenced in the\nquery text with `:name` syntax. Static values only.", + "description": "[Private Preview] A list of parameters to pass into the alert SQL query statement containing parameter markers. Static values only.\n\nReference a parameter in the query text as `:name`. Each parameter must have a unique, non-empty name.\nEach parameter consists of a name, a value, and optionally a type. To represent a NULL\nvalue, the `value` field may be omitted or set to `null` explicitly. If the `type` field\nis omitted, the value is interpreted as a string.\n\nIf the type is given, parameters will be checked for type correctness according\nto the given type. A value is correct if the provided string can be converted to\nthe requested type using the `cast` function. The exact semantics are described in\nthe section [`cast` function](https://docs.databricks.com/sql/language-manual/functions/cast.html) of the SQL language reference.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertStatementParameter", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -63,6 +67,7 @@ "parent_path": { "description": "The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "permissions": { @@ -74,27 +79,32 @@ "query_text": { "description": "Text of the query to be run.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "run_as": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "run_as_user_name": { "description": "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.279.0", "deprecated": true }, "schedule": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "warehouse_id": { "description": "ID of the SQL warehouse attached to the alert.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" } }, @@ -113,6 +123,7 @@ "budget_policy_id": { "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.243.0" }, "compute_max_instances": { @@ -131,6 +142,7 @@ }, "compute_size": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ComputeSize", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "config": { @@ -140,6 +152,7 @@ "description": { "description": "The description of the app.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "forward_user_access_token": { @@ -152,11 +165,13 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, "git_source": { "description": "[Beta] 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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.290.0" }, "lifecycle": { @@ -167,6 +182,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "permissions": { @@ -178,11 +194,13 @@ "resources": { "description": "Resources for the app.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.AppResource", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "source_code_path": { "description": "[Beta]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.239.0" }, "space": { @@ -195,16 +213,19 @@ "telemetry_export_destinations": { "description": "[Public Preview]", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.294.0" }, "usage_policy_id": { "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.283.0" }, "user_api_scopes": { "description": "[Public Preview]", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.246.0" } }, @@ -283,16 +304,19 @@ "comment": { "description": "User-provided free-form text description.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" }, "connection_name": { "description": "The name of the connection to an external data source.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.5.0" }, "grants": { @@ -309,36 +333,43 @@ "managed_encryption_settings": { "description": "Control CMK encryption for managed catalog data", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionSettings", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" }, "name": { "description": "Name of catalog.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" }, "options": { "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" }, "properties": { "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" }, "share_name": { "description": "The name of the share under the share provider.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" }, "storage_root": { "description": "Storage root URL for managed tables within catalog.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" } }, @@ -354,106 +385,127 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "dependency_mode": { "description": "[Beta] Controls dependency configuration for the cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DependencyMode", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.10.0" }, "docker_image": { "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "enable_local_disk_encryption": { "description": "Whether to enable LUKS on cluster VMs' local disks", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.237.0" }, "lifecycle": { @@ -464,11 +516,13 @@ "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 [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "permissions": { @@ -480,61 +534,73 @@ "policy_id": { "description": "The ID of the cluster policy used to create the cluster if applicable.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "single_user_name": { "description": "Single user name if data_security_mode is `SINGLE_USER`", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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 [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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.", + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Supported for GCP.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -576,16 +642,19 @@ "definition": { "description": "Policy definition document expressed in [Databricks Cluster Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).", "$ref": "#/$defs/interface", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.14.0" }, "description": { "description": "Additional human-readable description of the cluster policy.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.14.0" }, "libraries": { "description": "A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.Library", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.14.0" }, "lifecycle": { @@ -595,11 +664,13 @@ "max_clusters_per_user": { "description": "Max number of clusters per user that can be active using this policy. If not present, there is no max limit.", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.14.0" }, "name": { "description": "Cluster Policy name requested by the user. This has to be unique. Length must be between 1 and 100\ncharacters.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.14.0" }, "permissions": { @@ -611,11 +682,13 @@ "policy_family_definition_overrides": { "description": "Policy definition JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policy-definition.html).\nThe JSON document must be passed as a string and cannot be embedded in the requests.\n\nYou can use this to customize the policy definition inherited from the policy family.\nPolicy rules specified here are merged into the inherited policy definition.", "$ref": "#/$defs/interface", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.14.0" }, "policy_family_id": { "description": "ID of the policy family. The cluster policy's policy definition inherits the policy\nfamily's policy definition.\n\nCannot be used with `definition`. Use `policy_family_definition_overrides` instead to\ncustomize the policy definition.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.14.0" } }, @@ -742,16 +815,19 @@ "create_database_if_not_exists": { "description": "[Public Preview]", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "database_instance_name": { "description": "[Public Preview] The name of the DatabaseInstance housing the database.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "lifecycle": { @@ -762,6 +838,7 @@ "name": { "description": "[Public Preview] The name of the catalog in UC.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" } }, @@ -779,21 +856,25 @@ "capacity": { "description": "[Public Preview] The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_BETA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "lifecycle": { @@ -804,16 +885,19 @@ "name": { "description": "[Public Preview] The name of the instance. This is the unique identifier for the instance.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "permissions": { @@ -825,16 +909,19 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "usage_policy_id": { "description": "[Beta] The desired usage policy to associate with the instance.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.273.0" } }, @@ -849,31 +936,37 @@ "comment": { "description": "User-provided free-form text description.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "credential_name": { "description": "Name of the storage credential used with this location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "grants": { @@ -890,21 +983,25 @@ "name": { "description": "Name of the external location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "read_only": { "description": "Indicates whether the external location is read-only.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "skip_validation": { "description": "Skips validation of the storage credential associated with the external location.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "url": { "description": "Path URL of the external location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" } }, @@ -972,41 +1069,49 @@ "aws_attributes": { "description": "Attributes related to instance pools running on Amazon Web Services.\nIf not specified at pool creation, a set of default values will be used.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAwsAttributes", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "azure_attributes": { "description": "Attributes related to instance pools running on Azure.\nIf not specified at pool creation, a set of default values will be used.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAzureAttributes", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "custom_tags": { "description": "Additional tags for pool resources. Databricks will tag all pool 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", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "disk_spec": { "description": "Defines the specification of the disks that will be attached to all spark containers.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskSpec", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "enable_elastic_disk": { "description": "Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire\nadditional disk space when its Spark workers are running low on disk space. In AWS, this\nfeature requires specific AWS permissions to function correctly - refer to the User Guide for\nmore details.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "gcp_attributes": { "description": "Attributes related to instance pools running on Google Cloud Platform.\nIf not specified at pool creation, a set of default values will be used.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolGcpAttributes", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "idle_instance_autotermination_minutes": { "description": "Automatically terminates the extra instances in the pool cache after they are inactive for this\ntime in minutes if min_idle_instances requirement is already met. If not set, the extra pool\ninstances will be automatically terminated after a default timeout. If specified, the\nthreshold must be between 0 and 10000 minutes.\nUsers can also set this value to 0 to instantly remove idle instances from the cache if\nmin cache size could still hold.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "instance_pool_name": { "description": "Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100\ncharacters.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "lifecycle": { @@ -1017,21 +1122,25 @@ "max_capacity": { "description": "Maximum number of outstanding instances to keep in the pool, including both instances used by\nclusters and idle instances. Clusters that require further instance provisioning will fail during\nupsize requests.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "min_idle_instances": { "description": "Minimum number of idle instances to keep in the instance pool", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "node_type_flexibility": { "description": "Flexible node type configuration for the pool.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.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 [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "permissions": { @@ -1043,21 +1152,25 @@ "preloaded_docker_images": { "description": "Custom Docker Image BYOC", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "preloaded_spark_versions": { "description": "A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started\nwith the preloaded Spark version will start faster. A list of available Spark versions\ncan be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.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 types.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.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 types.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" } }, @@ -1103,41 +1216,49 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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.", + "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.\n\nPipelines started by a continuous job also run continuously, regardless of their own pipeline mode setting.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Continuous", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "lifecycle": { @@ -1148,21 +1269,25 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "parent_path": { @@ -1175,6 +1300,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.241.0" }, "permissions": { @@ -1186,41 +1312,49 @@ "queue": { "description": "The queue settings of the job.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "triggers": { "description": "[Beta] List of triggers attached to this job. A run starts when any active trigger evaluates to true. Cannot be set in\nthe same request as the legacy `schedule`, `trigger`, or `continuous` fields. Gated behind the \"Multiple Triggers\" feature preview.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.TriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" }, "usage_policy_id": { @@ -1233,6 +1367,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -1292,11 +1427,13 @@ "job_id": { "description": "The ID of the job to be executed", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.7.0" }, "job_parameters": { "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.7.0" }, "lifecycle": { @@ -1316,16 +1453,19 @@ "only": { "description": "A list of task keys to run inside of the job. If this field is not provided, all tasks in the job will be run.\n\nPrefix a task key with `+` to also run its upstream tasks, or suffix it with `+` to also run its downstream tasks.\nFor example, `+my_task` runs `my_task` and everything upstream of it, `my_task+` runs `my_task` and everything\ndownstream of it, and `+my_task+` runs both. A task key with no `+` runs only that task.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.7.0" }, "performance_target": { "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\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-databricks-launch-stage": "GA", "x-since-version": "v1.7.0" }, "pipeline_params": { "description": "Controls whether the pipeline should perform a full refresh", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.7.0" }, "python_named_params": { @@ -1349,6 +1489,7 @@ "queue": { "description": "The queue settings of the run.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.7.0" }, "spark_submit_params": { @@ -1435,6 +1576,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "lifecycle": { @@ -1445,6 +1587,7 @@ "name": { "description": "Experiment name.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "permissions": { @@ -1456,6 +1599,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "trace_location": { @@ -1507,6 +1651,7 @@ "description": { "description": "Optional description for registered model.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "lifecycle": { @@ -1517,6 +1662,7 @@ "name": { "description": "Register models under this name", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "permissions": { @@ -1528,6 +1674,7 @@ "tags": { "description": "Additional metadata for registered model.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelTag", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -1572,25 +1719,30 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.230.0" }, "budget_policy_id": { "description": "The budget policy to be applied to the serving endpoint.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "description": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "email_notifications": { "description": "Email notification settings.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EmailNotifications", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.264.0" }, "lifecycle": { @@ -1601,6 +1753,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "permissions": { @@ -1612,6 +1765,7 @@ "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -1619,16 +1773,19 @@ "route_optimized": { "description": "Enable route optimization for the serving endpoint.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "telemetry_config": { "description": "[Public Preview] Configuration for persisting endpoint telemetry (logs, traces, and metrics) to Unity Catalog tables.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TelemetryConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" } }, @@ -1702,11 +1859,13 @@ "allow_duplicate_names": { "description": "If false, deployment will fail if name conflicts with that of another pipeline.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.261.0" }, "budget_policy_id": { "description": "[Public Preview] Budget policy of this pipeline.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" }, "cascade_on_destroy": { @@ -1717,51 +1876,63 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "channel": { "description": "SDP Release Channel that specifies which version to use.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "configuration": { "description": "String-String configuration for this pipeline execution.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "continuous": { - "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", + "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.\n\nDeprecated: wrap the pipeline in a continuous job instead, which also lets you take advantage\nof job-level settings such as performance mode. When the pipeline is started by a continuous\njob, the job's setting takes precedence and this field is ignored.", "$ref": "#/$defs/bool", - "x-since-version": "v0.229.0" + "x-databricks-launch-stage": "GA", + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.229.0", + "deprecated": true }, "development": { "description": "Whether the pipeline is in Development mode. Defaults to false.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "edition": { "description": "Pipeline product edition.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "gateway_definition": { @@ -1774,16 +1945,19 @@ "id": { "description": "Unique identifier for this pipeline.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "lifecycle": { @@ -1794,16 +1968,19 @@ "name": { "description": "Friendly identifier for this pipeline.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.2.0" }, "permissions": { @@ -1815,6 +1992,7 @@ "photon": { "description": "Whether Photon is enabled for this pipeline.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "restart_window": { @@ -1827,21 +2005,25 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "x-since-version": "v0.241.0" }, "schema": { "description": "The default schema (database) where tables are read from or published to.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.230.0" }, "serverless": { "description": "Whether serverless compute is enabled for this pipeline.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "serverless_compute_id": { @@ -1854,16 +2036,19 @@ "storage": { "description": "DBFS root directory for storing checkpoints and tables.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -1871,6 +2056,7 @@ "trigger": { "description": "Which pipeline trigger to use. Deprecated: Use `continuous` instead.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineTrigger", + "x-databricks-launch-stage": "GA", "deprecationMessage": "Use continuous instead", "x-since-version": "v0.229.0", "deprecated": true @@ -1917,6 +2103,7 @@ }, "resources.PostgresBranch": { "type": "object", + "description": "[Beta]", "properties": { "branch_id": { "description": "The ID to use for the branch; becomes the final component of the branch's resource name. Must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens. For example, `development` becomes `projects/my-app/branches/development`.", @@ -1926,11 +2113,13 @@ "expire_time": { "description": "[Beta] Absolute expiration timestamp. When set, the branch will expire at this time.\nMutually exclusive with `ttl` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "is_protected": { "description": "[Beta] When set to true, protects the branch from deletion and reset. Associated compute endpoints and the project cannot be deleted while the branch is protected.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "lifecycle": { @@ -1941,6 +2130,7 @@ "no_expiry": { "description": "[Beta] Explicitly disable expiration. When set to true, the branch will not expire.\nIf set to false, the request is invalid; provide either ttl or expire_time instead.\nMutually exclusive with `expire_time` and `ttl`. When updating, use `spec.expiration` in the update_mask.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "parent": { @@ -1961,21 +2151,32 @@ "source_branch": { "description": "[Beta] The name of the source branch from which this branch was created (data lineage for point-in-time recovery).\nIf not specified, defaults to the project's default branch.\nFormat: projects/{project_id}/branches/{branch_id}", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "source_branch_lsn": { "description": "[Beta] The Log Sequence Number (LSN) on the source branch from which this branch was created.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "source_branch_time": { "description": "[Beta] The point in time on the source branch from which this branch was created.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, + "source_snapshot": { + "description": "[Private Preview] The snapshot this branch was created from. When set, the branch's data\ncomes from the snapshot rather than a source branch, so source_branch,\nsource_branch_lsn, and source_branch_time must be empty. The snapshot must\nbe AVAILABLE and belong to this branch's project.\nFormat: projects/{project_id}/snapshots/{snapshot_id}", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, "ttl": { "description": "[Beta] Relative time-to-live duration. When set, the branch will expire at creation_time + ttl.\nMutually exclusive with `expire_time` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" } }, @@ -1983,15 +2184,17 @@ "required": [ "branch_id", "parent" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, "resources.PostgresCatalog": { "type": "object", - "description": "The desired state of the Catalog.", + "description": "[Beta] The desired state of the Catalog.", "properties": { "branch": { "description": "[Beta] The resource path of the branch associated with the catalog.\n\nFormat: projects/{project_id}/branches/{branch_id}.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "catalog_id": { @@ -2002,6 +2205,7 @@ "create_database_if_missing": { "description": "[Beta] If set to true, the specified postgres_database is created on behalf of the calling user\nif it does not already exist. In this case, the calling user has a role created for\nthem in Postgres if they do not already have one.\n\nDefaults to false, meaning that the request fails if the specified postgres_database does not already exist.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "lifecycle": { @@ -2012,6 +2216,7 @@ "postgres_database": { "description": "[Beta] The name of the Postgres database inside the specified Lakebase project and branch to be associated with the UC catalog.\nThis database must already exist, unless create_database_if_missing is set to true on creation.\n\nA database can only be registered with one UC catalog at a time.\nTo re-register a database with a different catalog, the existing catalog must be deleted first.\n\nA child branch inherits the fact of parent's registration. This means the same-named database\nin a child branch cannot be registered with a second catalog\nwhile the parent's registration exists. To allow registering the database of a child branch,\ndrop and recreate the database on the child branch.\nThis removes the fact of parent's registration from this branch only.\n\nDoing Point In Time Restore (PITR) prior to the moment before the Postgres DB was registered\nin the Catalog drops the fact of registration of the database. So the user should avoid doing so.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" } }, @@ -2019,10 +2224,12 @@ "required": [ "catalog_id", "postgres_database" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, "resources.PostgresDatabase": { "type": "object", + "description": "[Beta]", "properties": { "database_id": { "description": "The ID to use for the database; becomes the final component of the database's resource name and the database name in Postgres. Must be 4-63 characters and use only characters available in DNS names, as defined by RFC 1123. If not specified, it is generated automatically.", @@ -2042,6 +2249,7 @@ "postgres_database": { "description": "[Beta] The name of the Postgres database.\n\nThis expects a valid Postgres identifier as specified in the link below.\nhttps://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS\nRequired when creating the Database.\n\nTo rename, pass a valid postgres identifier when updating the Database.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.4.0" }, "replace_existing": { @@ -2052,6 +2260,7 @@ "role": { "description": "[Beta] The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n\nTo change the owner, pass valid existing Role name when updating the Database\n\nA database always has an owner.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.4.0" } }, @@ -2060,24 +2269,29 @@ "database_id", "parent", "role" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, "resources.PostgresEndpoint": { "type": "object", + "description": "[Beta]", "properties": { "autoscaling_limit_max_cu": { "description": "[Beta] The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16.", "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_BETA", "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "disabled": { "description": "[Beta] Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "endpoint_id": { @@ -2088,11 +2302,13 @@ "endpoint_type": { "description": "[Beta] The endpoint type. A branch can only have one READ_WRITE endpoint.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointType", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "group": { "description": "[Beta] Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults\nto non HA settings, with a single compute backing the endpoint (and no readable secondaries\nfor Read/Write endpoints).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.290.0" }, "lifecycle": { @@ -2103,6 +2319,7 @@ "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.suspension` in the update_mask.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "parent": { @@ -2118,11 +2335,13 @@ "settings": { "description": "[Beta] A collection of settings for a compute endpoint.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings", + "x-databricks-launch-stage": "PUBLIC_BETA", "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.suspension` in the update_mask.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" } }, @@ -2131,44 +2350,53 @@ "endpoint_id", "parent", "endpoint_type" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, "resources.PostgresProject": { "type": "object", + "description": "[Beta]", "properties": { "budget_policy_id": { "description": "[Beta] The desired budget policy to associate with the project.\nSee status.budget_policy_id for the policy that is actually applied to the project.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.290.0" }, "custom_tags": { "description": "[Beta] Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking.\nTo update tags, provide the new tag list and include \"spec.custom_tags\" in the update_mask.\nTo clear all tags, provide an empty list and include \"spec.custom_tags\" in the update_mask.\nTo preserve existing tags, omit this field from the update_mask (or use wildcard \"*\" which auto-excludes empty tags).", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.ProjectCustomTag", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.290.0" }, "default_branch": { "description": "[Beta] The full resource path for the default branch of the project\nFormat: projects/{project_id}/branches/{branch_id}", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.298.0" }, "default_endpoint_settings": { "description": "[Beta] A collection of settings for a compute endpoint.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.ProjectDefaultEndpointSettings", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "display_name": { "description": "[Beta] Human-readable project name. Length should be between 1 and 256 characters.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "enable_pg_native_login": { "description": "[Beta] Whether to enable PG native password login on all endpoints in this project. Defaults to false.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.294.0" }, "history_retention_duration": { "description": "[Beta] The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "lifecycle": { @@ -2185,6 +2413,7 @@ "pg_version": { "description": "[Beta] The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "project_id": { @@ -2201,24 +2430,29 @@ "additionalProperties": false, "required": [ "project_id" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, "resources.PostgresRole": { "type": "object", + "description": "[Beta]", "properties": { "attributes": { "description": "[Beta] The desired API-exposed Postgres role attributes to associate with the role.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleAttributes", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.4.0" }, "auth_method": { "description": "[Beta] 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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.4.0" }, "identity_type": { "description": "[Beta] 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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.4.0" }, "lifecycle": { @@ -2229,6 +2463,7 @@ "membership_roles": { "description": "[Beta] Standard roles that this role is a member of.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.RoleMembershipRole", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.4.0" }, "parent": { @@ -2239,6 +2474,7 @@ "postgres_role": { "description": "[Beta] The name of the Postgres role. Required when creating the role.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.4.0" }, "replace_existing": { @@ -2256,10 +2492,36 @@ "required": [ "role_id", "parent" + ], + "x-databricks-launch-stage": "PUBLIC_BETA" + }, + "resources.PostgresSnapshotSchedule": { + "type": "object", + "properties": { + "branch": { + "description": "The branch whose automatic-snapshot schedule this manages. Format: projects/{project_id}/branches/{branch_id}", + "$ref": "#/$defs/string", + "x-since-version": "v1.16.0" + }, + "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.16.0" + }, + "schedule": { + "description": "The cadences at which automatic snapshots are taken. An empty set disables automatic snapshots. When several cadences fire together, one snapshot is taken and retained for the longest of their retentions.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.ScheduleCadence", + "x-since-version": "v1.16.0" + } + }, + "additionalProperties": false, + "required": [ + "branch" ] }, "resources.PostgresSyncedTable": { "type": "object", + "description": "[Beta]", "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 through Lakebase Accelerated Sync preview.", @@ -2271,16 +2533,19 @@ "branch": { "description": "[Beta] The full resource name the branch associated with the table.\n\nFormat: \"projects/{project_id}/branches/{branch_id}\".", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "create_database_objects_if_missing": { "description": "[Beta] If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.\nThe request will fail if this is false and the database/schema do not exist.\n\nDefaults to true if omitted.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "existing_pipeline_id": { "description": "[Beta] ID of an existing pipeline to bin-pack this synced table into.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "extra_columns": { @@ -2298,26 +2563,31 @@ "new_pipeline_spec": { "description": "[Beta] Specification for creating a new pipeline.\nAt most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nThe pipeline used for the synced table is returned via the top level pipeline_id attribute.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.NewPipelineSpec", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "postgres_database": { "description": "[Beta] The Postgres database name where the synced table will be created in.\n\nIf this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred\nfrom the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.\n\nA value must be specified when creating a synced table inside a Standard Catalog.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "primary_key_columns": { "description": "[Beta] Primary Key columns to be used for data insert/update in the destination.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "scheduling_policy": { "description": "[Beta] Scheduling policy of the underlying pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "source_table_full_name": { "description": "[Beta] Three-part (catalog, schema, table) name of the source Delta table.\n\nFor the corresponding destination table, use any of the two:\n\n* synced_table_id used at the creation of the SyncedTable\n* \"name\" consisting of \"synced_tables/\" prefix and the full name of the destination table.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "synced_table_id": { @@ -2328,18 +2598,21 @@ "timeseries_key": { "description": "[Beta] Time series key to deduplicate (tie-break) rows with the same primary key.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.0.0" }, "type_overrides": { "description": "[Beta] 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/postgres.SyncedTableSyncedTableSpecTypeOverride", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.5.0" } }, "additionalProperties": false, "required": [ "synced_table_id" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, "resources.QualityMonitor": { "type": "object", @@ -2347,16 +2620,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "data_classification_config": { @@ -2368,11 +2644,13 @@ }, "inference_log": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLog", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.264.0" }, "lifecycle": { @@ -2383,31 +2661,37 @@ "notifications": { "description": "[Create:OPT Update:OPT] Field for specifying notification settings.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorNotifications", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "table_name": { @@ -2417,11 +2701,13 @@ "time_series": { "description": "Configuration for monitoring time series tables.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorTimeSeries", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -2439,31 +2725,37 @@ "aliases": { "description": "List of aliases associated with the registered model", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RegisteredModelAlias", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "comment": { "description": "The comment attached to the registered model", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "created_by": { "description": "The identifier of the user who created the registered model", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "full_name": { "description": "The three-level (fully qualified) name of the registered model", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "grants": { @@ -2480,36 +2772,43 @@ "metastore_id": { "description": "The unique identifier of the metastore", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "name": { "description": "The name of the registered model", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "owner": { "description": "The identifier of the user who owns the registered model", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "schema_name": { "description": "The name of the schema where the registered model resides", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" } }, @@ -2522,16 +2821,19 @@ "catalog_name": { "description": "Name of parent catalog.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "comment": { "description": "User-provided free-form text description.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.5.0" }, "grants": { @@ -2548,16 +2850,19 @@ "name": { "description": "Name of schema, relative to parent catalog.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "properties": { "description": "A map of key-value properties attached to the securable.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "storage_root": { "description": "Storage root URL for managed tables within schema.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -2575,16 +2880,19 @@ "catalog_name": { "description": "The name of the catalog where the schema and the secret reside.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.12.0" }, "comment": { "description": "User-provided free-form text description of the secret.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.12.0" }, "expire_time": { "description": "User-provided expiration time of the secret. Purely informational; does not trigger automatic actions.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.12.0" }, "grants": { @@ -2600,21 +2908,25 @@ "name": { "description": "The name of the secret, relative to its parent schema.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.12.0" }, "owner": { "description": "The owner of the secret. Defaults to the creating principal on creation. Can be updated to\ntransfer ownership of the secret to another principal.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.12.0" }, "schema_name": { "description": "The name of the schema where the secret resides.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.12.0" }, "value": { "description": "The secret value to store. Must be a variable reference (e.g. ${var.my_secret}) to prevent plain-text secrets in configuration files.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.12.0" } }, @@ -2704,36 +3016,43 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "channel": { "description": "Channel Details", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Channel", + "x-databricks-launch-stage": "GA", "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", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "creator_name": { "description": "warehouse creator name", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "enable_serverless_compute": { "description": "Configures whether the warehouse should use serverless compute", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "instance_profile_arn": { "description": "Deprecated. Instance profile used to pass IAM role to the cluster", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.260.0", "deprecated": true @@ -2746,16 +3065,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "permissions": { @@ -2767,16 +3089,19 @@ "spot_instance_policy": { "description": "Configurations whether the endpoint should use spot instances.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SpotInstancePolicy", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" } }, @@ -2817,6 +3142,7 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" }, "lifecycle": { @@ -2827,16 +3153,19 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" }, "name": { "description": "[Public Preview] Full three-part (catalog, schema, table) name of the table.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" } }, @@ -2851,11 +3180,13 @@ "budget_policy_id": { "description": "[Public Preview] The budget policy id to be applied", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.298.0" }, "endpoint_type": { "description": "Type of endpoint", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" }, "lifecycle": { @@ -2866,6 +3197,7 @@ "name": { "description": "Name of the AI Search endpoint", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" }, "permissions": { @@ -2877,6 +3209,7 @@ "target_qps": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.299.2" }, "usage_policy_id": { @@ -2924,16 +3257,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "endpoint_name": { "description": "Name of the endpoint to be used for serving the index", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "grants": { @@ -2945,11 +3281,13 @@ "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-databricks-launch-stage": "PUBLIC_BETA", "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-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "lifecycle": { @@ -2960,11 +3298,13 @@ "name": { "description": "Name of the index", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "primary_key": { "description": "Primary key of the index", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" } }, @@ -2982,11 +3322,13 @@ "catalog_name": { "description": "The name of the catalog where the schema and the volume are", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.236.0" }, "comment": { "description": "The comment attached to the volume", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.236.0" }, "grants": { @@ -3003,21 +3345,25 @@ "name": { "description": "The name of the volume", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.236.0" }, "schema_name": { "description": "The name of the schema where the volume is", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.236.0" }, "storage_location": { "description": "The storage location on the cloud", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.236.0" } }, @@ -3293,11 +3639,21 @@ "config.Deployment": { "type": "object", "properties": { + "deployment_id": { + "description": "The ID the deployment metadata service assigned to this bundle's deployment. Output only.", + "$ref": "#/$defs/string", + "x-since-version": "v1.16.0" + }, "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" }, + "latest_version_id": { + "description": "The most recent version the deployment metadata service recorded for this deployment. Output only.", + "$ref": "#/$defs/int", + "x-since-version": "v1.16.0" + }, "lock": { "description": "The deployment lock attributes.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config.Lock", @@ -3309,6 +3665,11 @@ "config.Experimental": { "type": "object", "properties": { + "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.16.0" + }, "immutable_folder": { "description": "Whether to deploy bundle files and artifacts as a single immutable snapshot. When true, all files are packaged into a content-addressed archive and workspace.file_path and workspace.artifact_path are set to the resulting location.", "$ref": "#/$defs/bool", @@ -3331,11 +3692,6 @@ "$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", @@ -3589,6 +3945,11 @@ "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresRole", "x-since-version": "v1.4.0" }, + "postgres_snapshot_schedules": { + "description": "The Postgres snapshot schedule definitions for the bundle, where each key is the name of the snapshot schedule. Each entry configures the automatic-snapshot cadences for a branch of a Lakebase Autoscaling project.", + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresSnapshotSchedule", + "x-since-version": "v1.16.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", @@ -3897,31 +4258,37 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, "deployment_id": { "description": "The unique id of the deployment.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" } }, @@ -3933,6 +4300,7 @@ "source_code_path": { "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" } }, @@ -3971,52 +4339,64 @@ "properties": { "app": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceApp", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.290.0" }, "database": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceDatabase", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "description": { "description": "Description of the App Resource.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "experiment": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceExperiment", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, "genie_space": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceGenieSpace", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "job": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJob", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "name": { "description": "Name of the App Resource.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "postgres": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourcePostgres", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" }, "secret": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecret", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "serving_endpoint": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpoint", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "sql_warehouse": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouse", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "uc_securable": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurable", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.253.0" } }, @@ -4030,10 +4410,12 @@ "properties": { "name": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" }, "permission": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceAppAppPermission", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" } }, @@ -4050,14 +4432,17 @@ "properties": { "database_name": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "instance_name": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "permission": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceDatabaseDatabasePermission", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" } }, @@ -4079,10 +4464,12 @@ "properties": { "experiment_id": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, "permission": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceExperimentExperimentPermission", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" } }, @@ -4105,14 +4492,17 @@ "properties": { "name": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "permission": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceGenieSpaceGenieSpacePermission", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "space_id": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" } }, @@ -4138,11 +4528,13 @@ "id": { "description": "Id of the job to grant permission on.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" } }, @@ -4166,14 +4558,17 @@ "properties": { "branch": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" }, "database": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" }, "permission": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourcePostgresPostgresPermission", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" } }, @@ -4191,16 +4586,19 @@ "key": { "description": "Key of the secret to grant permission on.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "scope": { "description": "Scope of the secret to grant permission on.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" } }, @@ -4226,11 +4624,13 @@ "name": { "description": "Name of the serving endpoint to grant permission on.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" } }, @@ -4254,11 +4654,13 @@ "id": { "description": "Id of the SQL warehouse to grant permission on.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" } }, @@ -4281,14 +4683,17 @@ "properties": { "permission": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurableUcSecurablePermission", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.253.0" }, "securable_full_name": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.253.0" }, "securable_type": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurableUcSecurableType", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.253.0" } }, @@ -4362,16 +4767,19 @@ "name": { "description": "The name of the environment variable.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, "value": { "description": "The value for the environment variable.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" } }, @@ -4384,21 +4792,25 @@ "auto_deploy": { "description": "[Beta] When true, automatically deploys the app on push events to the branch configured in\nthe app's deployment_source.git_source.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.14.0" }, "caller_credential_id": { "description": "[Beta] ID of a personal access token Git credential owned by the caller, used to\ngrant the app's service principal access to this repository.", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.14.0" }, "provider": { "description": "Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud,\nbitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, "url": { "description": "URL of the Git repository.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" } }, @@ -4415,21 +4827,25 @@ "branch": { "description": "Git branch to checkout.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, "commit": { "description": "Git commit SHA to checkout.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, "tag": { "description": "Git tag to checkout.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" } }, @@ -4442,6 +4858,7 @@ "unity_catalog": { "description": "[Public Preview] Unity Catalog Destinations for OTEL telemetry export.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.UnityCatalog", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.294.0" } }, @@ -4454,16 +4871,19 @@ "logs_table": { "description": "[Public Preview] Unity Catalog table for OTEL logs.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.294.0" }, "metrics_table": { "description": "[Public Preview] Unity Catalog table for OTEL metrics.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.294.0" }, "traces_table": { "description": "[Public Preview] Unity Catalog table for OTEL traces (spans).", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.294.0" } }, @@ -4480,6 +4900,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" } }, @@ -4490,14 +4911,17 @@ "properties": { "azure_cmk_access_connector_id": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" }, "azure_cmk_managed_identity_id": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" }, "azure_tenant_id": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" } }, @@ -4512,16 +4936,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" } }, @@ -4534,6 +4961,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" } }, @@ -4546,16 +4974,19 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" }, "azure_key_vault_key_id": { "description": "the AKV URL in Azure, null otherwise.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" }, "customer_managed_key_id": { "description": "the CMK uuid in AWS and GCP, null otherwise.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.298.0" } }, @@ -4566,26 +4997,32 @@ "properties": { "managed_aqs": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "managed_pubsub": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "managed_sqs": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "provided_aqs": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "provided_pubsub": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "provided_sqs": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" } }, @@ -4597,6 +5034,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" } }, @@ -4608,16 +5046,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -4656,6 +5097,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -4667,36 +5109,43 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "label_col": { "description": "Column for the label.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "model_id_col": { "description": "Column for the model identifier.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "prediction_col": { "description": "Column for the prediction.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "prediction_proba_col": { "description": "Column for prediction probabilities", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "timestamp_col": { "description": "Column for the timestamp.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -4723,26 +5172,31 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "name": { "description": "Name of the metric in the output tables.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "output_data_type": { "description": "The output type of the custom metric.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -4770,6 +5224,7 @@ "on_failure": { "description": "Destinations to send notifications on failure/timeout.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "on_new_classification_tag_detected": { @@ -4794,11 +5249,13 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "timestamp_col": { "description": "Column for the timestamp.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -4870,11 +5327,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" } }, @@ -4886,31 +5345,37 @@ "alias_name": { "description": "Name of the alias, e.g. 'champion' or 'latest_stable'", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "catalog_name": { "description": "The name of the catalog containing the model version", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" }, "id": { "description": "The unique identifier of the alias", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.273.0" } }, @@ -4923,11 +5388,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" } }, @@ -4955,6 +5422,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -4969,11 +5437,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -4986,51 +5456,61 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5052,26 +5532,31 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "capacity_reservation_group": { "description": "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", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.5.0" }, "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5092,11 +5577,13 @@ "jobs": { "description": "With jobs set, the cluster can be used for jobs", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "notebooks": { "description": "With notebooks set, this cluster can be used for notebooks", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5109,16 +5596,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.242.0" } }, @@ -5147,176 +5637,211 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "dependency_mode": { "description": "[Beta] Controls dependency configuration for the cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DependencyMode", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.10.0" }, "docker_image": { "description": "Custom docker image BYOC", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "enable_local_disk_encryption": { "description": "Whether to enable LUKS on cluster VMs' local disks", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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 [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "single_user_name": { "description": "Single user name if data_security_mode is `SINGLE_USER`", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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 [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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.", + "description": "If set, what the total initial volume size (in GB) of the remote disks should be. Supported for GCP.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5369,6 +5894,7 @@ "destination": { "description": "dbfs destination, e.g. `dbfs:/my/path`", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5398,26 +5924,31 @@ "disk_count": { "description": "The number of disks launched for each instance:\n- This feature is only enabled for supported node types.\n- Users can choose up to the limit of the disks supported by the node type.\n- For node types with no OS disk, at least one disk must be specified;\notherwise, cluster creation will fail.\n\nIf disks are attached, Databricks will configure Spark to use only the disks for\nscratch storage, because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no disks are attached, Databricks will configure Spark to use\ninstance store disks.\n\nNote: If disks are specified, then the Spark configuration\n`spark.local.dir` will be overridden.\n\nDisks will be mounted at:\n- For AWS: `/ebs0`, `/ebs1`, and etc.\n- For Azure: `/remote_volume0`, `/remote_volume1`, and etc.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "disk_iops": { "description": "The number of IOPS to provision for each attached disk.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "disk_size": { "description": "The size of each disk (in GiB) launched for each instance.\nValues must fall into the supported range for a particular instance type.\n\nFor AWS:\n- General Purpose SSD: 100 - 4096 GiB\n- Throughput Optimized HDD: 500 - 4096 GiB\n\nFor Azure:\n- Premium LRS (SSD): 1 - 1023 GiB\n- Standard LRS (HDD): 1- 1023 GiB", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "disk_throughput": { "description": "The disk throughput to provision for each attached disk, in MB per second.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "disk_type": { "description": "The type of disks that will be launched with this cluster.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskType", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" } }, @@ -5430,11 +5961,13 @@ "azure_disk_volume_type": { "description": "All Azure Disk types that Databricks supports.\nSee https://docs.microsoft.com/en-us/azure/storage/storage-about-disks-and-vhds-linux#types-of-disks", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskTypeAzureDiskVolumeType", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "ebs_volume_type": { "description": "All EBS volume types that Databricks supports.\nSee https://aws.amazon.com/ebs/details/ for details.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskTypeEbsVolumeType", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" } }, @@ -5462,11 +5995,13 @@ "password": { "description": "Password of the user", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "username": { "description": "Name of the user", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5478,11 +6013,13 @@ "basic_auth": { "description": "Basic auth with username and password", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerBasicAuth", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "url": { "description": "URL of the docker image.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5503,11 +6040,13 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "client": { "description": "Use `environment_version` instead.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -5515,16 +6054,19 @@ "dependencies": { "description": "List of pip dependencies, as supported by the version of pip in this environment.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.252.0" }, "java_dependencies": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.271.0" } }, @@ -5537,11 +6079,13 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "boot_disk_size": { "description": "Boot disk size in GB", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "confidential_compute_type": { @@ -5554,21 +6098,25 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -5576,6 +6124,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5597,6 +6146,7 @@ "destination": { "description": "GCS destination/URI, e.g. `gs://my-bucket/some-prefix`", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5610,9 +6160,11 @@ "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" + "GPU_8xH100", + "GPU_1xH100" ], "enumDescriptions": [ + "[Beta]", "[Beta]", "[Beta]" ] @@ -5624,11 +6176,13 @@ "abfss": { "description": "Contains the Azure Data Lake Storage destination path", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Adlsgen2Info", + "x-databricks-launch-stage": "GA", "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -5636,26 +6190,31 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5668,21 +6227,25 @@ "availability": { "description": "Availability type used for the spot nodes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAwsAttributesAvailability", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "instance_profile_arn": { "description": "[Beta] All AWS instances belonging to the instance pool will have this instance profile. If omitted, instances\nwill initially be launched with the workspace's default instance profile. If defined, clusters that use the\npool will inherit the instance profile, and must not specify their own instance profile on cluster creation or\nupdate. If the pool does not specify an instance profile, clusters using the pool may specify any instance profile.\nThe instance profile must have previously been added to the Databricks environment by an account administrator.\n\nThis feature may only be available to certain customer plans.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.9.0" }, "spot_bid_price_percent": { "description": "Calculates 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-databricks-launch-stage": "GA", "x-since-version": "v1.9.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, a default zone will be used.\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-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" } }, @@ -5703,16 +6266,19 @@ "availability": { "description": "Availability type used for the spot nodes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAzureAttributesAvailability", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "capacity_reservation_group": { "description": "The Azure capacity reservation group resource ID to use for launching VMs in this pool.\nWhen specified, VMs will be launched using the provided capacity reservation.\n\nNOTE: Omitting this field will clear any existing configured capacity reservation group on the pool.\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", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "spot_bid_max_price": { "description": "With variable pricing, you have option to set a max price, in US dollars (USD)\nFor example, the value 2 would be a max price of $2.00 USD per hour.\nIf you set the max price to be -1, the VM won't be evicted based on price.\nThe price for the VM will be the current price for spot or the price for a standard VM,\nwhich ever is less, as long as there is capacity and quota available.", "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" } }, @@ -5733,16 +6299,19 @@ "gcp_availability": { "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.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "local_ssd_count": { "description": "If provided, each node in the instance pool will have this number of local SSDs attached.\nEach local SSD is 375GB in size. Refer 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-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" }, "zone_id": { "description": "Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west1-a\". The provided availability\nzone must be in the same region as the Databricks workspace. For example, \"us-west1-a\"\nis not a valid zone id if the Databricks workspace resides in the \"us-east1\" region.\nThis is an optional field at instance pool creation, and if not specified, a default zone will be used.\n\nThis field can be one of the following:\n- \"HA\" =\u003e High availability, spread nodes across availability zones for a Databricks deployment region\n- A GCP availability zone =\u003e Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones (e.g. \"us-west1-a\").\n\nIf empty, Databricks picks an availability zone to schedule the cluster on.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" } }, @@ -5769,11 +6338,13 @@ "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-databricks-launch-stage": "GA", "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -5781,26 +6352,31 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5812,6 +6388,7 @@ "destination": { "description": "local file destination, e.g. `file:/my/local/file.sh`", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5826,11 +6403,13 @@ "log_analytics_primary_key": { "description": "The primary key for the Azure Log Analytics agent configuration", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5842,16 +6421,19 @@ "coordinates": { "description": "Gradle-style maven coordinates. For example: \"org.jsoup:jsoup:1.7.2\".", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5867,7 +6449,14 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.285.0" + }, + "aws_context_id": { + "description": "The AWS Context ID for EC2 Fleet.\nWhen set (non-empty), the value is passed to AWS CreateFleet API to create the EC2 Fleet.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.16.0" } }, "additionalProperties": false @@ -5878,11 +6467,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5897,11 +6488,13 @@ "package": { "description": "The name of the CRAN package to install.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5925,36 +6518,43 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "enable_encryption": { "description": "(Optional) Flag to enable server side encryption, `false` by default.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5970,6 +6570,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -5985,6 +6586,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -6000,6 +6602,7 @@ "destination": { "description": "wsfs destination, e.g. `workspace:/cluster-init-scripts/setup-datadog.sh`", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -6021,11 +6624,13 @@ "key": { "description": "[Beta] The key of the custom tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.273.0" }, "value": { "description": "[Beta] The value of the custom tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.273.0" } }, @@ -6038,16 +6643,19 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "name": { "description": "[Public Preview] Name of the ref database instance.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" } }, @@ -6083,16 +6691,19 @@ "budget_policy_id": { "description": "[Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" } }, @@ -6181,36 +6792,43 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" }, "type_overrides": { @@ -6306,21 +6924,25 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" } }, @@ -6393,16 +7015,19 @@ "deployments": { "description": "[Public Preview] Deployment specs for this task. Exactly one deployment is currently\nsupported (a single entry where every node runs the same command); this\nis a current-Preview constraint. Role-split workloads (driver + worker,\nparameter server, separate eval node, etc.) with multiple entries are the\neventual intent but not yet supported.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.DeploymentSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" }, "docker_image_url": { "description": "[Beta] Optional Docker image URL for a custom container image. When set,\nthe task runs on the specified container image instead of the default\nDatabricks client image. Format:\n`{organization}/{repository}:{tag}`", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" }, "experiment": { "description": "[Public Preview] MLflow experiment name for this run. If an experiment with this name\nalready exists under the calling user, the run is appended to it;\notherwise a new experiment is created. To target a specific MLflow\nstorage location (for example, when running as a service principal), set\n`mlflow_experiment_directory`.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" }, "mlflow_artifact_location": { @@ -6415,11 +7040,13 @@ "mlflow_experiment_directory": { "description": "[Public Preview] Optional workspace directory under which the MLflow experiment named in\n`experiment` is created. Must start with `/Workspace`. Set this when\nrunning as a service principal that has no default user directory; for\nregular users the experiment defaults to the user's home directory.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" }, "mlflow_run": { "description": "[Public Preview] Optional display name for the MLflow run created under `experiment`. If\nomitted, MLflow generates a default name.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" } }, @@ -6435,21 +7062,32 @@ "alert_id": { "description": "[Public Preview] The alert_id is the canonical identifier of the alert.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, + "parameters": { + "description": "[Private Preview] Per-run parameter overrides, keyed by parameter name, applied onto the alert's stored\nquery parameters before the query is executed. Only scalar values are supported. Values\nmay reference job parameters with `{{job.parameters.*}}`, which are resolved before the\ntask runs. An override whose key does not match a stored parameter fails the task run.\nLimited to 10000 characters when serialized as JSON; keys must be 1-100 characters and\ncontain only letters, digits, underscores, dashes, and periods.", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" } }, @@ -6462,11 +7100,13 @@ "destination_id": { "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, "user_name": { "description": "[Public Preview] A valid workspace email address.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" } }, @@ -6490,21 +7130,25 @@ "clean_room_name": { "description": "The clean room that the notebook belongs to.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.237.0" }, "notebook_name": { "description": "Name of the notebook being run.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.237.0" } }, @@ -6520,6 +7164,7 @@ "hardware_accelerator": { "description": "[Beta] Hardware accelerator configuration for Serverless GPU workloads.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.288.0" } }, @@ -6562,11 +7207,13 @@ "accelerator_count": { "description": "[Public Preview] Total number of accelerators across all nodes. Must be a positive\nmultiple of the per-node accelerator count encoded in `accelerator_type`.\nFor example, `GPU_8xH100` with `accelerator_count: 16` allocates 2 nodes\n(8 GPUs per node).", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" }, "accelerator_type": { "description": "[Public Preview] Hardware accelerator type (for example, `GPU_1xA10` or `GPU_8xH100`).\nThe number of accelerators per node is encoded in the enum value —\n`GPU_8xH100` means 8 H100 GPUs per node.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpecAcceleratorType", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" } }, @@ -6603,16 +7250,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -6638,14 +7288,23 @@ "jobs.Continuous": { "type": "object", "properties": { + "maintenance_window": { + "description": "[Private Preview] Defines when platform-initiated maintenance may run for this job. If unspecified, maintenance may run at any time.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.MaintenanceWindow", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.267.0" } }, @@ -6655,9 +7314,17 @@ "type": "object", "description": "Continuous trigger. Stripped-down counterpart to `ContinuousSettings`: `pause_status` is owned by the enclosing\n`TriggerConfiguration` and intentionally omitted here.", "properties": { + "maintenance_window": { + "description": "[Private Preview] Defines when platform-initiated maintenance may run for this trigger. If unspecified,\nmaintenance may run at any time.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.MaintenanceWindow", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, "task_retry_mode": { "description": "[Beta] Whether the continuous job applies task-level retries. Defaults to NEVER.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskRetryMode", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" } }, @@ -6669,11 +7336,13 @@ "pause_status": { "description": "Indicate whether this schedule is paused or not.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "sql_condition": { @@ -6686,6 +7355,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -6702,11 +7372,13 @@ "quartz_cron_expression": { "description": "[Beta] A Cron expression using Quartz syntax that describes the schedule for this trigger. See\n[Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for details.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" }, "timezone_id": { "description": "[Beta] A Java timezone ID. The schedule is resolved with respect to this timezone. See\n[Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" } }, @@ -6723,6 +7395,7 @@ "dashboard_id": { "description": "The identifier of the dashboard to refresh.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.248.0" }, "filters": { @@ -6735,16 +7408,40 @@ "subscription": { "description": "Optional: subscription configuration for sending the dashboard snapshot.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Subscription", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.248.0" } }, "additionalProperties": false }, + "jobs.DayOfWeek": { + "type": "string", + "description": "Days of week that can be referenced by Jobs scheduling settings.", + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, "jobs.DbtCloudTask": { "type": "object", "description": "Deprecated in favor of DbtPlatformTask", @@ -6792,36 +7489,43 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -6837,16 +7541,19 @@ "command_path": { "description": "[Public Preview] Workspace path of the script to run on each node in this deployment.\nUpload the script to this path and supply the path here. When the task\nruns, the file at this path is run on each node; if it fails, the task\nfails with its exit code.\n\nExample script contents:\n\n# Plain Python:\npython train.py --epochs 10\n\n# Multi-GPU via accelerate:\naccelerate launch train.py --config config.yaml\n\n# Distributed via torchrun:\ntorchrun --nproc_per_node=8 train.py", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" }, "compute": { "description": "[Public Preview] Compute resources allocated to each node in this deployment.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" }, "name": { "description": "[Public Preview] Optional human-readable name for this deployment (for example, `driver`,\n`worker`, `param_server`). Used for log and UI display. Distinct names\nare recommended so deployments can be told apart, but uniqueness is not\nenforced.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" } }, @@ -6862,16 +7569,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -6886,16 +7596,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -6998,6 +7711,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7010,30 +7724,36 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "git_url": { "description": "URL of the repository to be cloned by this job.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "sparse_checkout": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparseCheckout", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.290.0" } }, @@ -7049,11 +7769,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "serverless_compute_id": { @@ -7075,11 +7797,13 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "metadata_file_path": { "description": "Path of the file that contains deployment metadata.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7118,6 +7842,7 @@ "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -7125,26 +7850,31 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7156,11 +7886,13 @@ "environment_key": { "description": "The key of an environment. It has to be unique within a job.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7175,11 +7907,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7191,11 +7925,13 @@ "default": { "description": "Default value of the parameter.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "name": { "description": "The name of the defined parameter. May only contain alphanumeric characters, `_`, `-`, and `.`", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7229,11 +7965,13 @@ "service_principal_name": { "description": "The application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7314,16 +8052,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7340,11 +8081,45 @@ "properties": { "rules": { "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRule", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, "additionalProperties": false }, + "jobs.MaintenanceWindow": { + "type": "object", + "description": "A recurring weekly time window during which platform-initiated maintenance is\nallowed to run for a continuous job.", + "properties": { + "day_of_week": { + "description": "[Private Preview] The day of week on which maintenance is allowed to happen. This field is required.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DayOfWeek", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, + "start_hour": { + "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the maintenance window in the 24-hour day.\nPlatform-initiated maintenance is triggered only within a one-hour window starting at this hour.\nThis field is required.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, + "timezone_id": { + "description": "[Private Preview] A Java timezone ID. The maintenance window 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-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + } + }, + "additionalProperties": false, + "required": [ + "day_of_week", + "start_hour", + "timezone_id" + ] + }, "jobs.ModelTriggerConfiguration": { "type": "object", "properties": { @@ -7408,21 +8183,25 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7452,11 +8231,13 @@ "interval": { "description": "The interval at which the trigger should run.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7481,26 +8262,31 @@ "full_refresh": { "description": "If true, triggers a full refresh on the spark declarative pipeline.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "full_refresh_selection": { "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "refresh_selection": { "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" } }, @@ -7512,36 +8298,43 @@ "full_refresh": { "description": "If true, triggers a full refresh on the spark declarative pipeline.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "full_refresh_selection": { "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.2.0" }, "pipeline_id": { "description": "The full name of the pipeline task to execute.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "refresh_selection": { "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" } }, @@ -7556,26 +8349,31 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, "model_name": { "description": "[Public Preview] The name of the Power BI model", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, "overwrite_existing": { "description": "[Public Preview] Whether to overwrite existing Power BI models", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" } }, @@ -7587,21 +8385,25 @@ "catalog": { "description": "[Public Preview] The catalog name in Databricks", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, "name": { "description": "[Public Preview] The table name in Databricks", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, "schema": { "description": "[Public Preview] The schema name in Databricks", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" } }, @@ -7613,26 +8415,31 @@ "connection_resource_name": { "description": "[Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" } }, @@ -7684,21 +8491,25 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "package_name": { "description": "Name of the package to execute", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7714,6 +8525,7 @@ "enabled": { "description": "If true, enable queueing for the job. This is a required field.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7766,11 +8578,13 @@ "job_id": { "description": "ID of the job to trigger.", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "job_parameters": { "description": "Job-level parameters used to trigger the job.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "notebook_params": { @@ -7785,6 +8599,7 @@ "pipeline_params": { "description": "Controls whether the pipeline should perform a full refresh", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "python_named_params": { @@ -7847,6 +8662,7 @@ "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -7854,16 +8670,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "run_as_repl": { "description": "Deprecated. A value of `false` is no longer supported.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.240.0", "deprecated": true @@ -7877,16 +8696,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7901,6 +8723,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -7912,6 +8735,7 @@ "patterns": { "description": "List of patterns to include for sparse checkout.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.290.0" } }, @@ -7966,31 +8790,37 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8005,16 +8835,19 @@ "alert_id": { "description": "The canonical identifier of the SQL alert.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "pause_subscriptions": { "description": "If true, the alert notifications are not sent to subscribers.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8029,21 +8862,25 @@ "custom_subject": { "description": "Subject of the email sent to subscribers of this task.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "dashboard_id": { "description": "The canonical identifier of the SQL dashboard.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8058,11 +8895,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8077,6 +8916,7 @@ "query_id": { "description": "The canonical identifier of the SQL query.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8091,11 +8931,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8120,16 +8962,19 @@ "custom_subject": { "description": "Optional: Allows users to specify a custom subject line on the email sent\nto subscribers.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.248.0" }, "paused": { "description": "When true, the subscription will not send emails.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.248.0" } }, @@ -8141,11 +8986,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.248.0" } }, @@ -8157,21 +9004,25 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8186,31 +9037,37 @@ "ai_runtime_task": { "description": "[Public Preview] The task runs a multi-gpu compute workload on Databricks AI Runtime. Specify\nthe accelerator type and count, the command to run, and where the workload's\ncode and MLflow output are stored.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiRuntimeTask", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" }, "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_BETA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.248.0" }, "dbt_cloud_task": { @@ -8232,46 +9089,55 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "description": { "description": "An optional description for this task.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "disable_auto_optimization": { "description": "An option to disable auto optimization in serverless", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "gen_ai_compute_task": { @@ -8284,51 +9150,61 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, "python_operator_task": { @@ -8341,36 +9217,43 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -8378,21 +9261,25 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8407,11 +9294,13 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "task_key": { "description": "The name of the task this task depends on.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8426,6 +9315,7 @@ "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -8433,26 +9323,31 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8464,16 +9359,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8489,16 +9387,18 @@ }, "jobs.TriggerConfiguration": { "type": "object", - "description": "A single trigger attached to a job via `JobSettings.triggers`. Exactly one of the trigger-type fields\n(`periodic`, `schedule`, `continuous`, `file_arrival`, `table_update`, `model`) must be set; mutual exclusivity\nis enforced in the API handler rather than via `oneof` so that codegen, validation, and JSON serialization\nacross SDKs and Terraform behave consistently.", + "description": "A single trigger attached to a job via `JobSettings.triggers`. Exactly one of the trigger-type fields\n(`periodic`, `schedule`, `continuous`, `file_arrival`, `table_update`, `model`, `job_completion`) must be set;\nmutual exclusivity is enforced in the API handler rather than via `oneof` so that codegen, validation, and JSON\nserialization across SDKs and Terraform behave consistently.", "properties": { "continuous": { "description": "[Beta] Continuous trigger configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ContinuousTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" }, "file_arrival": { "description": "[Beta] File arrival trigger configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" }, "model": { @@ -8511,16 +9411,19 @@ "pause_status": { "description": "[Beta] Whether this trigger is paused. Defaults to UNPAUSED when unset; the server always returns an explicit value on read.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" }, "periodic": { "description": "[Beta] Trigger type: exactly one must be set; mutual exclusivity is enforced in the API handler\nPeriodic trigger configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" }, "schedule": { "description": "[Beta] Cron schedule trigger configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CronTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" }, "sql_condition": { @@ -8533,6 +9436,7 @@ "table_update": { "description": "[Beta] Table update trigger configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" } }, @@ -8544,6 +9448,7 @@ "file_arrival": { "description": "File arrival trigger settings.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "model": { @@ -8556,11 +9461,13 @@ "pause_status": { "description": "Whether this trigger is paused or not.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "periodic": { "description": "Periodic trigger settings.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "sql_condition": { @@ -8572,6 +9479,7 @@ }, "table_update": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8582,6 +9490,7 @@ "properties": { "id": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8596,26 +9505,31 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8637,11 +9551,13 @@ "key": { "description": "The tag key.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "value": { "description": "The tag value.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8668,11 +9584,13 @@ "key": { "description": "The tag key.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "value": { "description": "The tag value.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8756,11 +9674,13 @@ "enabled": { "description": "[Public Preview] (Required, Mutable) Whether to enable auto full refresh or not.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.285.0" } }, @@ -8776,6 +9696,7 @@ "include_confluence_spaces": { "description": "[Public Preview] (Optional) Spaces to filter Confluence data on", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" } }, @@ -8808,6 +9729,7 @@ "confluence_options": { "description": "[Public Preview] Confluence specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" }, "gdrive_options": { @@ -8827,11 +9749,13 @@ "jira_options": { "description": "[Beta] Jira specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "kafka_options": { "description": "[Beta]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "linkedin_ads_options": { @@ -8851,6 +9775,7 @@ "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "outlook_options": { @@ -8860,6 +9785,12 @@ "doNotSuggest": true, "x-since-version": "v0.299.2" }, + "rabbitmq_options": { + "description": "[Beta] RabbitMQ specific options for ingestion.\nPerformance tuning options (consumers_per_task, max_messages_per_fetch, etc.)\nare intentionally not exposed in the public API. The managed connector uses\nsensible defaults internally. These can be added later if user demand arises.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RabbitmqOptions", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.16.0" + }, "reddit_ads_options": { "description": "[Private Preview] Reddit Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RedditAdsOptions", @@ -8891,6 +9822,7 @@ "zendesk_support_options": { "description": "[Public Preview] Zendesk Support specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" } }, @@ -8913,10 +9845,12 @@ "properties": { "quartz_cron_schedule": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "timezone_id": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -8929,16 +9863,19 @@ "catalog_name": { "description": "[Public Preview] (Required, Immutable) The name of the catalog for the connector's staging storage location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, "schema_name": { "description": "[Public Preview] (Required, Immutable) The name of the schema for the connector's staging storage location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, "volume_name": { "description": "[Public Preview] (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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" } }, @@ -8984,16 +9921,19 @@ "catalog": { "description": "The UC catalog the event log is published under.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.246.0" }, "name": { "description": "The name the event log is published to in UC.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.246.0" }, "schema": { "description": "The UC schema the event log is published under.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.246.0" } }, @@ -9156,6 +10096,7 @@ "path": { "description": "The absolute path of the source code.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -9167,11 +10108,13 @@ "exclude": { "description": "Paths to exclude.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "include": { "description": "Paths to include.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -9312,16 +10255,19 @@ "report": { "description": "[Public Preview] Select a specific source report.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" } }, @@ -9388,31 +10334,37 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "connector_type": { "description": "[Public Preview] (Optional) Connector Type for sources. Ex: CDC, Query Based.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.296.0" }, "data_staging_options": { "description": "[Public Preview] (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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "netsuite_jar_path": { @@ -9425,16 +10377,19 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" } }, @@ -9447,11 +10402,13 @@ "fanout_by": { "description": "[Beta] Column path or SQL expression whose value determines the destination table.\nSupports dotted paths (e.g. \"value.event_name\") and expressions\n(e.g. \"value:event_name::string\").", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.10.0" }, "transforms": { "description": "[Beta] Optional transforms applied to each route's DataFrame before writing\nto the destination table.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.10.0" } }, @@ -9464,16 +10421,19 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.264.0" } }, @@ -9552,6 +10512,7 @@ "CONFLUENCE", "META_MARKETING", "ZENDESK", + "RABBITMQ", "FOREIGN_CATALOG" ], "enumDescriptions": [ @@ -9574,6 +10535,7 @@ "[Public Preview]", "[Beta]", "[Public Preview]", + "[Beta]", "[Private Preview]" ] }, @@ -9584,6 +10546,7 @@ "include_jira_spaces": { "description": "[Beta] (Optional) Projects to filter Jira data on", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" } }, @@ -9595,26 +10558,31 @@ "as_variant": { "description": "[Beta] Parse the entire value as a single Variant column.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "schema": { "description": "[Beta] Inline schema string for JSON parsing (Spark DDL format).", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "schema_evolution_mode": { "description": "[Beta] (Optional) Schema evolution mode for schema inference.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "schema_file_path": { "description": "[Beta] Path to a schema file (.ddl).", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "schema_hints": { "description": "[Beta] (Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" } }, @@ -9633,6 +10601,7 @@ "key_transformer": { "description": "[Beta] (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": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "max_offsets_per_trigger": { @@ -9645,21 +10614,25 @@ "starting_offset": { "description": "[Beta] (Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "topic_pattern": { "description": "[Beta] 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": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "topics": { "description": "[Beta] Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "value_transformer": { "description": "[Beta] (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": "PUBLIC_BETA", "x-since-version": "v1.1.0" } }, @@ -9800,6 +10773,7 @@ "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", + "x-databricks-launch-stage": "PUBLIC_BETA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.299.2", "deprecated": true @@ -9807,6 +10781,7 @@ "action_breakdowns": { "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.action_breakdowns) Action breakdowns", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.299.2", "deprecated": true @@ -9814,6 +10789,7 @@ "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", + "x-databricks-launch-stage": "PUBLIC_BETA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.299.2", "deprecated": true @@ -9821,6 +10797,7 @@ "breakdowns": { "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.breakdowns) Breakdowns to configure", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.299.2", "deprecated": true @@ -9828,6 +10805,7 @@ "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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "custom_report_options": { @@ -9840,6 +10818,7 @@ "level": { "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.level) Granularity of data to pull\n(account, ad, adset, campaign)", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.299.2", "deprecated": true @@ -9847,11 +10826,13 @@ "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-databricks-launch-stage": "PUBLIC_BETA", "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", + "x-databricks-launch-stage": "PUBLIC_BETA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.299.2", "deprecated": true @@ -9914,6 +10895,7 @@ "path": { "description": "The absolute path of the source code.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -9925,11 +10907,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -9942,16 +10926,19 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.285.0" } }, @@ -10077,6 +11064,7 @@ "include": { "description": "[Public Preview] The source code to include for pipelines", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.252.0" } }, @@ -10088,96 +11076,115 @@ "apply_policy_default_values": { "description": "Note: This field won't be persisted. Only API users will check this field.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "enable_local_disk_encryption": { "description": "Whether to enable local disk encryption for the cluster.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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`.", + "description": "A label for the cluster specification, either `default` to configure the default cluster settings applied to both the update and maintenance clusters, `updates` to configure the update cluster, or `maintenance` to configure the maintenance cluster. This field is optional. The default value is `default`.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -10189,16 +11196,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -10222,11 +11232,13 @@ "kind": { "description": "The deployment method that manages the pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "metadata_file_path": { "description": "The path to the file containing metadata about the deployment.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -10241,11 +11253,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.252.0" }, "jar": { @@ -10265,11 +11279,13 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "whl": { "description": "URI of the whl to be installed.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -10292,10 +11308,12 @@ "properties": { "cron": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.CronTrigger", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "manual": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -10308,11 +11326,13 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.257.0" }, "environment_version": { - "description": "[Beta] 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\"`.", + "description": "[Public 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": "PUBLIC_PREVIEW", "x-since-version": "v0.294.0" } }, @@ -10325,6 +11345,7 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" } }, @@ -10337,16 +11358,34 @@ "publication_name": { "description": "[Public Preview] The name of the publication to use for the Postgres source", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" } }, "additionalProperties": false }, + "pipelines.RabbitmqOptions": { + "type": "object", + "description": "RabbitMQ specific options for ingestion.\nPerformance tuning options (consumers_per_task, max_messages_per_fetch, etc.)\nare intentionally not exposed in the public API. The managed connector uses\nsensible defaults internally. These can be added later if user demand arises.", + "properties": { + "queue": { + "description": "[Beta] (Required) RabbitMQ queue name to consume from.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.16.0" + } + }, + "additionalProperties": false, + "required": [ + "queue" + ] + }, "pipelines.RedditAdsOptions": { "type": "object", "description": "Reddit Ads specific options for ingestion", @@ -10402,26 +11441,31 @@ "destination_catalog": { "description": "[Public Preview] Required. Destination catalog to store table.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.231.0" }, "destination_schema": { "description": "[Public Preview] Required. Destination schema to store table.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.231.0" }, "source_url": { "description": "[Public Preview] Required. Report URL in the source system.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.231.0" } }, @@ -10469,11 +11513,13 @@ "service_principal_name": { "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.241.0" } }, @@ -10485,44 +11531,50 @@ "connector_options": { "description": "[Public Preview] (Optional) Source Specific Connector Options", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.298.0" }, "destination_catalog": { "description": "[Public Preview] Required. Destination catalog to store tables.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "fanout_options": { "description": "[Beta] Fanout options for multi-table routing from streaming sources.\nWhen set, records are routed to destination tables based on a\nper-record routing key. The key value becomes the table name:\n{destination_catalog}.{destination_schema}.{key_value}.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionFanoutOptions", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.10.0" }, "source_catalog": { "description": "[Public Preview] The source catalog name. Might be optional depending on the type of source.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "source_schema": { - "description": "[Public Preview] Schema name in the source database. Currently required; this field will become optional in\nan upcoming release, since some source types (for example streaming / message-bus connectors)\ndo not use it. When that change ships, this field's type in the generated SDKs and CLI will\nchange from required to optional (nullable); clients that assume it is always present should\nhandle its absence.", + "description": "[Public Preview] Schema name in the source database. Optional: some source types (for example streaming or\nmessage-bus connectors) do not use it, so it may be absent from a pipeline's definition.\nClients that assume it is always present should handle its absence.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" } }, "additionalProperties": false, "required": [ "destination_catalog", - "destination_schema", - "source_schema" + "destination_schema" ] }, "pipelines.SharepointOptions": { @@ -10588,11 +11640,13 @@ "postgres": { "description": "[Public Preview] Postgres-specific catalog-level configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" }, "source_catalog": { "description": "[Public Preview] Source catalog name", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" } }, @@ -10611,6 +11665,7 @@ "catalog": { "description": "[Public Preview] Catalog-level source configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" }, "google_ads_config": { @@ -10629,49 +11684,56 @@ "connector_options": { "description": "[Public Preview] (Optional) Source Specific Connector Options", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.298.0" }, "destination_catalog": { "description": "[Public Preview] Required. Destination catalog to store table.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "destination_schema": { "description": "[Public Preview] Required. Destination schema to store table.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "source_table": { - "description": "[Public Preview] Table name in the source database. Currently required; this field will become optional in\nan upcoming release, since some source types (for example streaming / message-bus connectors)\ndo not use it. When that change ships, this field's type in the generated SDKs and CLI will\nchange from required to optional (nullable); clients that assume it is always present should\nhandle its absence.", + "description": "[Public Preview] Table name in the source database. Optional: some source types (for example streaming or\nmessage-bus connectors) do not use it, so it may be absent from a pipeline's definition.\nClients that assume it is always present should handle its absence.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" } }, "additionalProperties": false, "required": [ "destination_catalog", - "destination_schema", - "source_table" + "destination_schema" ] }, "pipelines.TableSpecificConfig": { @@ -10680,41 +11742,49 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.285.0" }, "clustering_columns": { "description": "[Beta] 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": "PUBLIC_BETA", "x-since-version": "v1.5.0" }, "enable_auto_clustering": { "description": "[Beta] 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": "PUBLIC_BETA", "x-since-version": "v1.5.0" }, "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.283.0" }, "salesforce_include_formula_fields": { @@ -10727,21 +11797,25 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.231.0" }, "source_metadata_column": { "description": "[Beta] (Optional) Name of the struct column added to each ingested record to hold per row source\nmetadata.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.9.0" }, "table_properties": { "description": "[Beta] 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": "PUBLIC_BETA", "x-since-version": "v1.5.0" }, "workday_report_parameters": { @@ -10926,6 +12000,7 @@ "format": { "description": "[Beta] Required: the wire format of the data.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "input_column": { @@ -10938,6 +12013,7 @@ "json_options": { "description": "[Beta]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.1.0" }, "output_column": { @@ -10968,27 +12044,67 @@ "start_date": { "description": "[Public 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": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" } }, "additionalProperties": false }, + "postgres.DailySchedule": { + "type": "object", + "description": "Take a snapshot once per day, at the configured hour.", + "properties": { + "hour": { + "description": "[Private Preview] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + } + }, + "additionalProperties": false + }, + "postgres.DayOfWeek": { + "type": "string", + "description": "The day of the week on which a weekly snapshot is taken.", + "enum": [ + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, "postgres.EndpointGroupSpec": { "type": "object", "properties": { "enable_readable_secondaries": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.290.0" }, "max": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.290.0" }, "min": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.290.0" } }, @@ -11005,6 +12121,7 @@ "pg_settings": { "description": "A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" } }, @@ -11018,12 +12135,37 @@ "ENDPOINT_TYPE_READ_ONLY" ] }, + "postgres.MonthlySchedule": { + "type": "object", + "description": "Take a snapshot once per month, on the configured day at the configured hour.", + "properties": { + "day": { + "description": "[Private Preview] The day of the month on which to take the snapshot, in [1, 31]. In shorter\nmonths the snapshot is taken on the last day instead (day 31 runs on Feb 28\nor 29, and on Apr 30), so every month gets exactly one snapshot.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, + "hour": { + "description": "[Private Preview] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + } + }, + "additionalProperties": false, + "required": [ + "day" + ] + }, "postgres.NewPipelineSpec": { "type": "object", "properties": { "budget_policy_id": { "description": "Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.0.0" }, "pipeline_channel": { @@ -11036,11 +12178,13 @@ "storage_catalog": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v1.0.0" }, "storage_schema": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v1.0.0" } }, @@ -11064,11 +12208,13 @@ "key": { "description": "The key of the custom tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.290.0" }, "value": { "description": "The value of the custom tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.290.0" } }, @@ -11081,26 +12227,31 @@ "autoscaling_limit_max_cu": { "description": "The maximum number of Compute Units. Minimum value is 0.5.", "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" }, "autoscaling_limit_min_cu": { "description": "The minimum number of Compute Units. Minimum value is 0.5.", "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" }, "no_suspension": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" }, "pg_settings": { "description": "A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" }, "suspend_timeout_duration": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" } }, @@ -11113,16 +12264,19 @@ "bypassrls": { "description": "Grants the Postgres `BYPASSRLS` attribute, which lets the role bypass every row-level security policy.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.4.0" }, "createdb": { "description": "Grants the Postgres `CREATEDB` attribute, which lets the role create databases.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.4.0" }, "createrole": { "description": "Grants the Postgres `CREATEROLE` attribute, which lets the role create, alter, and drop other roles.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.4.0" } }, @@ -11153,6 +12307,44 @@ "DATABRICKS_SUPERUSER" ] }, + "postgres.ScheduleCadence": { + "type": "object", + "description": "One cadence at which automatic snapshots are taken.", + "properties": { + "daily_schedule": { + "description": "[Private Preview] Take a snapshot once per day.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.DailySchedule", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, + "monthly_schedule": { + "description": "[Private Preview] Take a snapshot once per month.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.MonthlySchedule", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, + "retention": { + "description": "[Private Preview] How long snapshots from this cadence are kept before automatic deletion.\nMust be at least 1 hour. Applied when a snapshot is taken; not retroactive,\nso changing it affects only later snapshots.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, + "weekly_schedule": { + "description": "[Private Preview] Take a snapshot once per week.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.WeeklySchedule", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + } + }, + "additionalProperties": false, + "required": [ + "retention" + ] + }, "postgres.SyncedTableSyncedTableSpecExtraColumn": { "type": "object", "description": "An extra PostgreSQL column to add to the synced table.", @@ -11227,16 +12419,19 @@ "column_name": { "description": "Name of the source column whose target PostgreSQL type should be overridden.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.5.0" }, "pg_type": { "description": "PostgreSQL-specific target type to use for the column.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecPgSpecificType", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.5.0" }, "size": { "description": "Size parameter for the target type, for types that take one (e.g. vector\ndimension, varchar length). Required when the chosen pg_type needs a size.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.5.0" } }, @@ -11246,17 +12441,43 @@ "pg_type" ] }, + "postgres.WeeklySchedule": { + "type": "object", + "description": "Take a snapshot once per week, on the configured day at the configured hour.", + "properties": { + "day_of_week": { + "description": "[Private Preview] The day of the week on which to take the snapshot.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.DayOfWeek", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + }, + "hour": { + "description": "[Private Preview] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.16.0" + } + }, + "additionalProperties": false, + "required": [ + "day_of_week" + ] + }, "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11268,26 +12489,31 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.230.0" } }, @@ -11299,6 +12525,7 @@ "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", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.230.0", "deprecated": true @@ -11306,16 +12533,19 @@ "pii": { "description": "[Public Preview] Configuration for guardrail PII filter.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" }, "safety": { "description": "[Public Preview] Indicates whether the safety filter is enabled.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.230.0", "deprecated": true @@ -11329,6 +12559,7 @@ "behavior": { "description": "[Public Preview] Configuration for input guardrail filters.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" } }, @@ -11353,11 +12584,13 @@ "input": { "description": "[Public Preview] Configuration for input guardrail filters.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" } }, @@ -11369,21 +12602,25 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.230.0" }, "enabled": { "description": "Indicates whether the inference table is enabled.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.230.0" } }, @@ -11395,26 +12632,31 @@ "calls": { "description": "Used to specify how many calls are allowed for a key within the renewal_period.", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.265.0" } }, @@ -11453,6 +12695,7 @@ "enabled": { "description": "Whether to enable usage tracking.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.230.0" } }, @@ -11464,36 +12707,43 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "aws_region": { "description": "The AWS region to use. Bedrock has to be enabled there.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.243.0" } }, @@ -11524,11 +12774,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11540,16 +12792,19 @@ "key": { "description": "The name of the API key parameter used for authentication.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.246.0" } }, @@ -11565,21 +12820,25 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "enabled": { "description": "Indicates whether the inference table is enabled.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11591,11 +12850,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.246.0" } }, @@ -11607,16 +12868,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11629,16 +12893,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.246.0" } }, @@ -11653,16 +12920,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11677,11 +12947,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.264.0" } }, @@ -11693,6 +12965,7 @@ "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", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.229.0", "deprecated": true @@ -11700,16 +12973,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11721,11 +12997,13 @@ "key": { "description": "Key field for a serving endpoint tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "value": { "description": "Optional value field for a serving endpoint tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11740,61 +13018,73 @@ "ai21labs_config": { "description": "AI21Labs Config. Only required if the provider is 'ai21labs'.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "name": { "description": "The name of the external model.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "task": { "description": "The task type of the external model.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11836,6 +13126,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.246.0" } }, @@ -11850,21 +13141,25 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11881,56 +13176,67 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11942,11 +13248,13 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -11958,16 +13266,19 @@ "calls": { "description": "Used to specify how many calls are allowed for a key within the renewal_period.", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -12002,16 +13313,19 @@ "properties": { "served_entity_name": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -12026,75 +13340,90 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "entity_version": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "provisioned_model_units": { "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -12106,69 +13435,83 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "model_name": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "model_version": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, "provisioned_model_units": { "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -12246,21 +13589,25 @@ "enabled_telemetry_features": { "description": "[Public Preview] The telemetry signals to enable for this endpoint. If empty or omitted, all signals are\nenabled; otherwise only the listed signals are enabled.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.TelemetryFeature", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.14.0" }, "inference_table_config": { "description": "[Public Preview] Configuration for inference table payload logging, including sampling.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TelemetryInferenceTableConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" }, "table_names": { "description": "[Public Preview] The Unity Catalog tables to which endpoint telemetry (logs, traces, and metrics) is exported.\nProvide this to create a new telemetry profile for the endpoint from the given tables.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.UnityCatalogTableNames", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.10.0" }, "telemetry_profile_id": { "description": "[Public Preview] The ID of an existing telemetry profile to apply to this endpoint. Provide this to reuse a\ntelemetry profile that has already been created, instead of specifying table_names.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.10.0" } }, @@ -12289,6 +13636,7 @@ "sampling_fraction": { "description": "[Public Preview] Fraction of requests sampled for payload logging, in the range [0.0, 1.0], where 1.0 logs all requests.", "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" } }, @@ -12300,6 +13648,7 @@ "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" } }, @@ -12311,21 +13660,25 @@ "annotations_table": { "description": "[Public Preview] The full three-level Unity Catalog name (catalog.schema.table) of the table that receives\nexported annotations.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.10.0" }, "logs_table": { "description": "[Public Preview] The full three-level Unity Catalog name (catalog.schema.table) of the table that receives\nexported logs.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.10.0" }, "metrics_table": { "description": "[Public Preview] The full three-level Unity Catalog name (catalog.schema.table) of the table that receives\nexported metrics.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.10.0" }, "traces_table": { "description": "[Public Preview] The full three-level Unity Catalog name (catalog.schema.table) of the table that receives\nexported traces (spans).", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.10.0" } }, @@ -12363,24 +13716,24 @@ }, "sql.AlertStatementParameter": { "type": "object", - "description": "Redash-owned copy of the internal StatementParameter for the external AlertV2 API.\nThe internal `ordinal` and `args` fields are intentionally omitted: the public API\nsupports only flat, named scalar parameters; complex types (ARRAY, MAP, STRUCT) are\nnot supported. This mirrors SEA's public StatementParameter schema, see:\ncmdexec/sql-exec-api/proto/sql_exec_api_service.proto:763-779", + "description": "A named parameter bound to the alert query. Only flat, named scalar parameters are\nsupported; complex types such as ARRAY, MAP, and STRUCT are not.", "properties": { "name": { - "description": "[Private Preview] The name of the parameter, referenced in the query as `:name`.", + "description": "[Private Preview] The name of the parameter. Reference it in the query text as `:name`. Required, must be\nnon-empty, and must be unique across the alert's parameters.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.10.0" }, "type": { - "description": "[Private Preview] The SQL data type of the parameter, e.g. STRING, INT, or DATE. Defaults to STRING. This is a\nstring rather than an enum because scalar subtypes such as DECIMAL(10, 4) cannot be enumerated.\nComplex types such as ARRAY, MAP, and STRUCT are not supported.", + "description": "[Private Preview] The SQL data type of the parameter, for example `STRING`, `INT`, or `DECIMAL(10, 2)`. If no type is given\nthe type is assumed to be `STRING`. Complex types such as `ARRAY`, `MAP`, and `STRUCT` are not supported.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.10.0" }, "value": { - "description": "[Private Preview] The bound value for the parameter, given as a string. If omitted, the value is interpreted as NULL.", + "description": "[Private Preview] The value bound to the parameter, represented as a string. If omitted, the value is interpreted as NULL.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -12398,26 +13751,31 @@ "comparison_operator": { "description": "Operator used for comparison in alert evaluation.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "empty_result_state": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "notification": { "description": "User or Notification Destination to notify when alert is triggered.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Notification", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "source": { "description": "Source column from result to use to evaluate alert", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "threshold": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" } }, @@ -12433,15 +13791,18 @@ "notify_on_ok": { "description": "Whether to notify alert subscribers when alert returns back to normal.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "retrigger_seconds": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "subscriptions": { "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" } }, @@ -12452,10 +13813,12 @@ "properties": { "column": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "value": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" } }, @@ -12467,14 +13830,17 @@ "aggregation": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "display": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "name": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" } }, @@ -12488,14 +13854,17 @@ "properties": { "bool_value": { "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "double_value": { "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "string_value": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" } }, @@ -12507,11 +13876,13 @@ "service_principal_name": { "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "user_name": { "description": "The email of an active workspace user. Can only set this field to their own email.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" } }, @@ -12522,10 +13893,12 @@ "properties": { "destination_id": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "user_email": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" } }, @@ -12537,10 +13910,12 @@ "properties": { "dbsql_version": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "name": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ChannelName", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" } }, @@ -12582,16 +13957,19 @@ "pause_status": { "description": "Indicate whether this schedule is paused or not.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "quartz_cron_schedule": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "timezone_id": { "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" } }, @@ -12606,10 +13984,12 @@ "properties": { "key": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, "value": { "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" } }, @@ -12620,6 +14000,7 @@ "properties": { "custom_tags": { "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.EndpointTagPair", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" } }, @@ -12658,36 +14039,43 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "source_table": { "description": "The name of the source table.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" } }, @@ -12699,16 +14087,19 @@ "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" } }, @@ -12720,16 +14111,19 @@ "embedding_model_endpoint_name": { "description": "Name of the embedding model endpoint, used by default for both ingestion and querying.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "name": { "description": "Name of the column", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" } }, @@ -12741,11 +14135,13 @@ "embedding_dimension": { "description": "Dimension of the embedding vector", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "name": { "description": "Name of the column", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" } }, @@ -12813,11 +14209,13 @@ "dns_name": { "description": "The DNS of the KeyVault", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "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-databricks-launch-stage": "GA", "x-since-version": "v0.252.0" } }, @@ -12990,6 +14388,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresRole" } }, + "resources.PostgresSnapshotSchedule": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresSnapshotSchedule" + } + }, "resources.PostgresSyncedTable": { "type": "object", "additionalProperties": { @@ -13457,6 +14861,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleMembershipRole" } }, + "postgres.ScheduleCadence": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.ScheduleCadence" + } + }, "postgres.SyncedTableSyncedTableSpecExtraColumn": { "type": "array", "items": { From 9b62078acff66db4981194fff27c86fec2e5d43e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 16 Sep 2026 13:53:26 +0000 Subject: [PATCH 22/31] Update jsonschema_for_docs.json for v1.17.0 --- bundle/schema/jsonschema_for_docs.json | 1160 ++++++++++++++++++++++-- 1 file changed, 1073 insertions(+), 87 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 9ee28de6fba..38e1214a799 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -1536,9 +1536,14 @@ "type": "object", "properties": { "on_bundle_deploy": { - "description": "If true, re-fire the run on every bundle deploy. Incompatible with lifecycle.prevent_destroy.", + "description": "If true, re-fire the run on every bundle deploy.", "$ref": "#/$defs/bool", "x-since-version": "v1.13.0" + }, + "on_file_change": { + "description": "Path or glob relative to the defining YAML file. It must resolve under the sync root. Re-fire the run when a matched file's content hash changes, or when the set of matches appears or disappears. Only files the bundle syncs are hashed, so .gitignore and sync.exclude apply. Use * to match a single directory level; ** is not supported.", + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" } }, "additionalProperties": false @@ -1570,6 +1575,40 @@ }, "additionalProperties": false }, + "resources.McpService": { + "type": "object", + "properties": { + "comment": { + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" + }, + "config": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.McpServiceConfig", + "x-since-version": "v1.17.0" + }, + "grants": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "x-since-version": "v1.17.0" + }, + "lifecycle": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.17.0" + }, + "mcp_service_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" + }, + "parent": { + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "parent", + "mcp_service_id" + ] + }, "resources.MlflowExperiment": { "type": "object", "properties": { @@ -1713,6 +1752,74 @@ "level" ] }, + "resources.ModelProviderService": { + "type": "object", + "properties": { + "comment": { + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" + }, + "config": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfig", + "x-since-version": "v1.17.0" + }, + "grants": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "x-since-version": "v1.17.0" + }, + "lifecycle": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.17.0" + }, + "model_provider_service_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" + }, + "parent": { + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "parent", + "model_provider_service_id" + ] + }, + "resources.ModelService": { + "type": "object", + "properties": { + "comment": { + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" + }, + "config": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfig", + "x-since-version": "v1.17.0" + }, + "grants": { + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment", + "x-since-version": "v1.17.0" + }, + "lifecycle": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.17.0" + }, + "model_service_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" + }, + "parent": { + "$ref": "#/$defs/string", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "parent", + "model_service_id" + ] + }, "resources.ModelServingEndpoint": { "type": "object", "properties": { @@ -2111,7 +2218,7 @@ "x-since-version": "v0.287.0" }, "expire_time": { - "description": "[Beta] Absolute expiration timestamp. When set, the branch will expire at this time.\nMutually exclusive with `ttl` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.", + "description": "[Beta] Absolute expiration timestamp. When set, the branch will expire at this time.\nMutually exclusive with `ttl` and `no_expiry`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" @@ -2128,7 +2235,7 @@ "x-since-version": "v0.287.0" }, "no_expiry": { - "description": "[Beta] Explicitly disable expiration. When set to true, the branch will not expire.\nIf set to false, the request is invalid; provide either ttl or expire_time instead.\nMutually exclusive with `expire_time` and `ttl`. When updating, use `spec.expiration` in the update_mask.", + "description": "[Beta] Explicitly disable expiration. When set to true, the branch will not expire.\nIf set to false, the request is invalid; provide either ttl or expire_time instead.\nMutually exclusive with `expire_time` and `ttl`.", "$ref": "#/$defs/bool", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" @@ -2174,7 +2281,7 @@ "x-since-version": "v1.16.0" }, "ttl": { - "description": "[Beta] Relative time-to-live duration. When set, the branch will expire at creation_time + ttl.\nMutually exclusive with `expire_time` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.", + "description": "[Beta] Relative time-to-live duration. When set, the branch will expire at creation_time + ttl.\nMutually exclusive with `expire_time` and `no_expiry`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" @@ -2317,7 +2424,7 @@ "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.suspension` in the update_mask.", + "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`.", "$ref": "#/$defs/bool", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" @@ -2339,7 +2446,7 @@ "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.suspension` in the update_mask.", + "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`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" @@ -3897,6 +4004,18 @@ "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" }, + "mcp_services": { + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.McpService", + "x-since-version": "v1.17.0" + }, + "model_provider_services": { + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelProviderService", + "x-since-version": "v1.17.0" + }, + "model_services": { + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ModelService", + "x-since-version": "v1.17.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", @@ -4897,145 +5016,852 @@ "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", + "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-databricks-launch-stage": "GA", + "x-since-version": "v0.289.0" + } + }, + "additionalProperties": false + }, + "catalog.AzureEncryptionSettings": { + "type": "object", + "properties": { + "azure_cmk_access_connector_id": { + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v0.298.0" + }, + "azure_cmk_managed_identity_id": { + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v0.298.0" + }, + "azure_tenant_id": { + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "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-databricks-launch-stage": "GA", + "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-databricks-launch-stage": "GA", + "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-databricks-launch-stage": "GA", + "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-databricks-launch-stage": "GA", + "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-databricks-launch-stage": "GA", + "x-since-version": "v0.298.0" + }, + "azure_key_vault_key_id": { + "description": "the AKV URL in Azure, null otherwise.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v0.298.0" + }, + "customer_managed_key_id": { + "description": "the CMK uuid in AWS and GCP, null otherwise.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "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-databricks-launch-stage": "GA", + "x-since-version": "v0.289.0" + }, + "managed_pubsub": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", + "x-databricks-launch-stage": "GA", + "x-since-version": "v0.289.0" + }, + "managed_sqs": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", + "x-databricks-launch-stage": "GA", + "x-since-version": "v0.289.0" + }, + "provided_aqs": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage", + "x-databricks-launch-stage": "GA", + "x-since-version": "v0.289.0" + }, + "provided_pubsub": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", + "x-databricks-launch-stage": "GA", + "x-since-version": "v0.289.0" + }, + "provided_sqs": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", + "x-databricks-launch-stage": "GA", + "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-databricks-launch-stage": "GA", + "x-since-version": "v0.289.0" + } + }, + "additionalProperties": false + }, + "catalog.InferenceTableConfig": { + "type": "object", + "description": "Configuration for logging request and response payloads to a Unity Catalog\ninference table. When this configuration is present, payload logging is\nenabled by default.", + "properties": { + "parent": { + "description": "Parent Unity Catalog schema where the inference table is created, in the\nform `schemas/{catalog}.{schema}`. Required when configuring an inference\ntable. After the inference table is created, this field cannot be changed.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "table_name_prefix": { + "description": "Prefix used to form the inference table's registered name. AI Gateway\nappends `_payload`; for example, `table_name_prefix = \"orders\"` creates\n`orders_payload`. If unset, the prefix defaults to the service name. Read\n`table` from the response for the resulting resource name. After the\ninference table is created, this field cannot be changed.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "parent" + ] + }, + "catalog.McpServiceConfig": { + "type": "object", + "description": "Operational configuration for an MCP service. Groups the source reference,\ntool selectors, and rate limits -- the fields that configure how the MCP\nservice behaves at invocation time.", + "properties": { + "include_tool_selectors": { + "description": "Tool names or prefix patterns to expose from the MCP server. Use exact\ntool names or prefix patterns such as `read_*`. An empty list exposes all\ntools. At most 1,024 selectors are allowed, and each selector can contain\nat most 256 characters.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "rate_limits": { + "description": "Rate limits for tool invocations. Supported scopes are user, group, service\nprincipal, the service as a whole, and each user by default. Request and\ntoken limits are supported. Empty when no rate limit is configured.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RateLimit", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "source_connection": { + "description": "Unity Catalog connection referencing the MCP server. Required on Create.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.McpServiceConfigSourceConnection", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.McpServiceConfigSourceConnection": { + "type": "object", + "description": "Unity Catalog connection that points to the MCP server. On Create, provide\n`name` in the schema-scoped form\n`connections/{catalog}.{schema}.{connection}`. On read, the service\npopulates the resolved connection metadata. If the connection is deleted,\nits reference remains visible so you can identify the broken dependency.", + "properties": { + "name": { + "description": "Resource name of the Unity Catalog connection used to access the MCP\nserver, in the form `connections/{catalog}.{schema}.{connection}`.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "name" + ] + }, + "catalog.ModelProviderServiceConfig": { + "type": "object", + "description": "Behavioral configuration for a ModelProviderService: provider authentication\nand provider-specific fields, the catalog of models this provider\nservice can route to, and the passthrough policy that governs how request\nheaders, query parameters, and unmanaged subpaths cross the trust boundary\nto the upstream provider.", + "properties": { + "allow_all_targets": { + "description": "When true, accepts any model exposed by the upstream provider; `targets`\nis not required and does not restrict routability. When false, only\nmodels listed in `targets` are routable. Defaults to false.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "amazon_bedrock": { + "description": "Amazon Bedrock provider configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAmazonBedrockProviderConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "anthropic": { + "description": "Anthropic provider configuration. Exactly one of `direct` or `relayed` must\nbe set on Create; the two are mutually exclusive.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAnthropicProviderConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "azure_openai": { + "description": "Azure OpenAI provider configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAzureOpenAiProviderConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "custom": { + "description": "Custom OpenAI-compatible provider configuration with bearer-token\nauthentication.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigCustomProviderConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "forward_headers": { + "description": "Whether to forward incoming HTTP headers to the upstream provider. Defaults\nto false and is configured for the entire provider service, not per request.\nUpstream authentication is configured separately in the provider-specific\nconfiguration.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "forward_query_parameters": { + "description": "Whether to forward incoming query parameters to the upstream provider.\nDefaults to false and is configured for the entire provider service, not\nper request.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "forward_unmanaged_paths": { + "description": "Whether to proxy paths that AI Gateway does not recognize as configured\nprovider-native API types. Defaults to false. When true, these paths are\nforwarded unchanged to the upstream provider. When false, only\nrecognized API paths are served. Enabling this broadens the upstream API\nsurface exposed through the provider service.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "gemini_enterprise": { + "description": "Gemini Enterprise provider configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigGeminiEnterpriseProviderConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "inference_table": { + "description": "Payload logging configuration for requests sent directly to this provider\nservice. Requests routed through a model service are captured by that model\nservice's inference table instead.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.InferenceTableConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "microsoft_foundry": { + "description": "Microsoft Foundry provider configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigMicrosoftFoundryProviderConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "openai": { + "description": "OpenAI provider configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigOpenAiProviderConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "provider_type": { + "description": "External model provider. Required on Create and immutable thereafter. Set\nthe matching provider-specific configuration, such as `openai`,\n`azure_openai`, or `amazon_bedrock`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigExternalModelProviderType", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "rate_limits": { + "description": "Rate limits for requests sent directly to this provider service. Requests\nrouted through a model service use that model service's rate limits instead.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RateLimit", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "targets": { + "description": "Models and provider-native API types exposed by this provider service. Each\nentry must include at least one `native_api_types` value. When\n`allow_all_targets` is false, at least one entry is required and model\nservice destinations can reference only listed models. When\n`allow_all_targets` is true, any upstream model is routable; entries in\nthis list provide API-type metadata without restricting other models.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigModelTargetConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigAmazonBedrockProviderConfig": { + "type": "object", + "description": "Amazon Bedrock provider configuration.", + "properties": { + "direct": { + "description": "Amazon Bedrock region and authentication configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAmazonBedrockProviderDirectConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigAmazonBedrockProviderDirectConfig": { + "type": "object", + "description": "Direct form of Amazon Bedrock provider config.\n\nAuthentication is one of two mutually exclusive modes, exactly one of which\nmust be supplied on Create:\n- Access keys: set `aws_access_key`, leave `service_credential` unset.\n- Unity Catalog service credential: set `service_credential.name` to the\nresource name `credentials/{name}`, leave `aws_access_key` unset. The\ncredential value lives in Unity Catalog and is referenced by name, not\nheld on this message.\nSetting more than one mode is rejected.", + "properties": { + "aws_access_key": { + "description": "AWS access-key-pair authentication. Set `access_key_id` and\n`secret_access_key.plaintext`. Mutually exclusive with\n`service_credential`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAwsAccessKey", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "region": { + "description": "AWS region where the Bedrock endpoint is hosted (e.g., `us-east-1`).\nRequired on Create.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "service_credential": { + "description": "Reference to a Unity Catalog service credential authorizing Bedrock\nrequests. On Create, supply `service_credential.name` in the form\n`credentials/{name}`. Required on Create when using service-credential\nauthentication; mutually exclusive with `aws_access_key`. The credential\nis referenced by name; its value is not carried here. Only\nsupported on AWS-hosted workspaces.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigServiceCredential", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigAnthropicProviderConfig": { + "type": "object", + "description": "Anthropic provider configuration. Exactly one of `direct` or `relayed` must\nbe set on Create; the two are mutually exclusive.", + "properties": { + "direct": { + "description": "Direct authentication with an API key supplied in\n`direct.api_key.plaintext`. Required unless `relayed` is set.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAnthropicProviderDirectConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "relayed": { + "description": "Relayed authentication. Each inference request supplies the caller's\nOAuth token, which is forwarded to Anthropic. No Anthropic credential is\nstored. Mutually exclusive with `direct`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAnthropicProviderRelayedConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigAnthropicProviderDirectConfig": { + "type": "object", + "description": "Direct form of Anthropic provider config.", + "properties": { + "api_key": { + "description": "Anthropic API key. Required when creating the service. Supply the value\nin `api_key.plaintext`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigAnthropicProviderRelayedConfig": { + "type": "object", + "description": "Relayed Anthropic provider configuration. Each inference request supplies\nthe caller's OAuth token, which is forwarded to Anthropic. No Anthropic\ncredential is stored.", + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigAwsAccessKey": { + "type": "object", + "description": "AWS access-key-pair auth for Amazon Bedrock: a SigV4-signing key pair.", + "properties": { + "access_key_id": { + "description": "AWS access key ID. Required on Create when using access-key auth. Treated as\nusername-equivalent (not a secret value): round-trips on reads and is\nscrubbed from audit logs.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "secret_access_key": { + "description": "AWS secret access key paired with `access_key_id`. Required when creating\na service with access-key authentication. Supply the value in\n`secret_access_key.plaintext`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigAzureOpenAiProviderConfig": { + "type": "object", + "description": "Azure OpenAI provider configuration.", + "properties": { + "direct": { + "description": "Azure OpenAI endpoint and authentication configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAzureOpenAiProviderDirectConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigAzureOpenAiProviderDirectConfig": { + "type": "object", + "description": "Direct form of Azure OpenAI provider config. Exactly one of three\nmutually-exclusive auth modes must be supplied on Create:\n- API key: set `api_key`, leave `entra_service_principal` and\n`service_credential` unset.\n- Entra ID (service principal): set `entra_service_principal`, leave\n`api_key` and `service_credential` unset.\n- Unity Catalog service credential: set `service_credential.name` to the\nresource name `credentials/{name}`, leave `api_key` and\n`entra_service_principal` unset. The credential value lives in Unity\nCatalog and is referenced by name, not held on this message. Only\nsupported on Azure-hosted workspaces.\nSetting more than one mode is rejected.", + "properties": { + "api_key": { + "description": "Azure OpenAI API key. Supply the value in `api_key.plaintext`. Mutually\nexclusive with Entra ID and Unity Catalog service credential\nauthentication.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "base_url": { + "description": "Full Azure OpenAI endpoint base URL, e.g.\n`https://myresource.openai.azure.com`. Required on Create.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "entra_service_principal": { + "description": "Entra ID service-principal authentication. Set `tenant_id`, `client_id`,\nand `client_secret.plaintext`. Mutually exclusive with `api_key` and\n`service_credential`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigEntraServicePrincipal", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "service_credential": { + "description": "Reference to a Unity Catalog service credential authorizing Azure OpenAI\nrequests. On Create, supply `service_credential.name` in the form\n`credentials/{name}`. Required on Create when using service-credential\nauthentication; mutually exclusive with `api_key` and\n`entra_service_principal`. The credential is referenced by name; its value\nis not carried here. Only supported on Azure-hosted workspaces.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigServiceCredential", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigCustomProviderConfig": { + "type": "object", + "description": "Custom OpenAI-compatible provider configuration with bearer-token\nauthentication.", + "properties": { + "direct": { + "description": "Endpoint and authentication configuration for the custom provider.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigCustomProviderDirectConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigCustomProviderDirectConfig": { + "type": "object", + "description": "Direct form of a custom provider configuration. Set `api_key` to the bearer\ntoken sent in the `Authorization` header.", + "properties": { + "api_key": { + "description": "Bearer token forwarded in the `Authorization` header. Supply the value\nin `api_key.plaintext`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "base_url": { + "description": "Endpoint URL of the OpenAI-compatible service (e.g.,\n`https://api.example.com/v1`). Required on Create.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigEntraServicePrincipal": { + "type": "object", + "description": "Entra ID (Azure AD) service-principal authentication. The `tenant_id` and\n`client_id` identify the service principal, and `client_secret` authenticates\nit. AI Gateway exchanges these credentials for an Entra bearer token for\nrequests to Azure OpenAI or Microsoft Foundry.", + "properties": { + "client_id": { + "description": "Entra ID client (application) ID. Required on Create.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "client_secret": { + "description": "Entra ID client secret. Supply the value in `client_secret.plaintext`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "tenant_id": { + "description": "Entra ID (Azure AD) tenant ID. Required on Create.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigExternalModelProviderType": { + "type": "string", + "description": "External LLM provider for an EXTERNAL_FOUNDATION_MODEL destination.", + "enum": [ + "EXTERNAL_MODEL_PROVIDER_TYPE_OPENAI", + "EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI", + "EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC", + "EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK", + "EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM", + "EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY", + "EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE" + ] + }, + "catalog.ModelProviderServiceConfigGeminiEnterpriseProviderConfig": { + "type": "object", + "description": "Gemini Enterprise provider configuration.", + "properties": { + "direct": { + "description": "Gemini Enterprise project, region, and authentication configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigGeminiEnterpriseProviderDirectConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigGeminiEnterpriseProviderDirectConfig": { + "type": "object", + "description": "Direct Gemini Enterprise provider configuration. An API key is required\nwhen creating the service.", + "properties": { + "api_key": { + "description": "Google Gemini Enterprise API key. Required when creating the service.\nSupply the value in `api_key.plaintext`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "project_id": { + "description": "GCP project ID hosting the Gemini Enterprise endpoint. Required on Create.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "region": { + "description": "GCP region of the Gemini Enterprise endpoint (e.g., `us-central1`).\nRequired on Create.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigMicrosoftFoundryProviderConfig": { + "type": "object", + "description": "Microsoft Foundry provider configuration.", + "properties": { + "direct": { + "description": "Microsoft Foundry endpoint and authentication configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigMicrosoftFoundryProviderDirectConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigMicrosoftFoundryProviderDirectConfig": { + "type": "object", + "description": "Direct form of Microsoft Foundry provider config.\n\nAuthentication is one of three mutually exclusive modes, exactly one of which\nmust be supplied on Create:\n- API key: set `api_key`, leave `entra_service_principal` and\n`service_credential` unset.\n- Entra ID (service principal): set `entra_service_principal`, leave\n`api_key` and `service_credential` unset. AI Gateway exchanges these for\nan Entra bearer token on outbound requests via the OAuth2\nclient-credentials grant.\n- Unity Catalog service credential: set `service_credential.name` to the\nresource name `credentials/{name}`, leave `api_key` and\n`entra_service_principal` unset. The credential value lives in Unity\nCatalog and is referenced by name, not held on this message. Only\nsupported on Azure-hosted workspaces.\nSetting more than one mode is rejected.", + "properties": { + "api_key": { + "description": "Microsoft Foundry API key. Supply the value in `api_key.plaintext`.\nMutually exclusive with Entra ID and Unity Catalog service credential\nauthentication.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "base_url": { + "description": "Microsoft Foundry endpoint URL. Required on Create.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "entra_service_principal": { + "description": "Entra ID service-principal authentication. Set `tenant_id`, `client_id`,\nand `client_secret.plaintext`. Mutually exclusive with `api_key` and\n`service_credential`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigEntraServicePrincipal", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "service_credential": { + "description": "Reference to a Unity Catalog service credential authorizing Microsoft\nFoundry requests. On Create, supply `service_credential.name` in the form\n`credentials/{name}`. Required on Create when using service-credential\nauthentication; mutually exclusive with `api_key` and\n`entra_service_principal`. The credential is referenced by name; its value\nis not carried here. Only supported on Azure-hosted workspaces.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigServiceCredential", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false + }, + "catalog.ModelProviderServiceConfigModelTargetConfig": { + "type": "object", + "description": "Model target configuration for an external model destination.", + "properties": { + "model": { + "description": "Provider-side model identifier, such as `gpt-5` or `claude-opus-4-7`.\nThis identifies a model at the upstream provider; it is not a Unity\nCatalog model resource.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "native_api_types": { + "description": "Provider-native API types supported by this model, such as\n`openai/v1/chat/completions`. At least one value is required. AI Gateway\nuses these values to translate requests and responses. At most 64 entries\nof 256 characters each are allowed.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "model" + ] + }, + "catalog.ModelProviderServiceConfigOpenAiProviderConfig": { + "type": "object", + "description": "OpenAI provider configuration.", + "properties": { + "direct": { + "description": "OpenAI configuration with an API key supplied in the request.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigOpenAiProviderDirectConfig", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" } }, "additionalProperties": false }, - "catalog.AzureEncryptionSettings": { + "catalog.ModelProviderServiceConfigOpenAiProviderDirectConfig": { "type": "object", + "description": "Direct (inline-credentials) form of the OpenAI provider config.", "properties": { - "azure_cmk_access_connector_id": { - "$ref": "#/$defs/string", + "api_key": { + "description": "OpenAI API key. Required when creating the service. Supply the value in\n`api_key.plaintext`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.298.0" + "x-since-version": "v1.17.0" }, - "azure_cmk_managed_identity_id": { + "base_url": { + "description": "Optional custom base URL. Defaults to `https://api.openai.com/v1`. Use for\nOpenAI-API-compatible third-party endpoints or in-network proxies.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.298.0" + "x-since-version": "v1.17.0" }, - "azure_tenant_id": { + "organization": { + "description": "Optional OpenAI organization ID. When set, the platform forwards it as\nthe `OpenAI-Organization` header.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.298.0" + "x-since-version": "v1.17.0" } }, - "additionalProperties": false, - "required": [ - "azure_tenant_id" - ] + "additionalProperties": false }, - "catalog.AzureQueueStorage": { + "catalog.ModelProviderServiceConfigProviderSecret": { "type": "object", + "description": "A secret value supplied as part of an inline provider config. The caller\nsupplies the value as inline `plaintext` on writes; the platform stores it\nencrypted. The `plaintext` field is `INPUT_ONLY` and never round-trips on\nreads.", "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-databricks-launch-stage": "GA", - "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-databricks-launch-stage": "GA", - "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", + "plaintext": { + "description": "Inline plaintext credential. INPUT_ONLY: the value never round-trips on\nreads. Get and List responses omit `plaintext`; the enclosing secret\nobject remains present to indicate that a secret is configured.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" } }, "additionalProperties": false }, - "catalog.EncryptionDetails": { + "catalog.ModelProviderServiceConfigServiceCredential": { "type": "object", - "description": "Encryption options that apply to clients connecting to cloud storage.", + "description": "The customer-owned Unity Catalog service credential a model provider service\nuses to authenticate to its provider, referenced by name.", "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", + "name": { + "description": "Resource name of the bound Unity Catalog service credential, in the form\n`credentials/{name}`. Supply this field when creating the service or\nrebinding its credential. On read, it reflects the credential's current\nname.", + "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" } }, - "additionalProperties": false + "additionalProperties": false, + "required": [ + "name" + ] }, - "catalog.EncryptionSettings": { + "catalog.ModelServiceConfig": { "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.", + "description": "Operational configuration wrapped around the ModelService resource.", "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", + "inference_table": { + "description": "Inference table configuration for payload logging.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.InferenceTableConfig", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.298.0" + "x-since-version": "v1.17.0" }, - "azure_key_vault_key_id": { - "description": "the AKV URL in Azure, null otherwise.", - "$ref": "#/$defs/string", + "rate_limits": { + "description": "Rate limits applied to requests routed through this model service.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RateLimit", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.298.0" + "x-since-version": "v1.17.0" }, - "customer_managed_key_id": { - "description": "the CMK uuid in AWS and GCP, null otherwise.", - "$ref": "#/$defs/string", + "routing": { + "description": "Routing configuration: destinations and fallback.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfigRoutingConfig", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.298.0" + "x-since-version": "v1.17.0" } }, "additionalProperties": false }, - "catalog.FileEventQueue": { + "catalog.ModelServiceConfigDestinationConfig": { "type": "object", + "description": "A destination the model service can route traffic to. Exactly one of the\nper-type configs inside `type_config` must be set, and it must match\n`destination_type`.", "properties": { - "managed_aqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage", + "destination_type": { + "description": "Backing-model category. Provide the matching type-specific configuration\nand leave the other type-specific configurations unset.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfigDestinationConfigDestinationType", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" }, - "managed_pubsub": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", + "external_model_config": { + "description": "Configuration for an external model reached through a model provider service.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfigExternalModelConfig", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" }, - "managed_sqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", + "name": { + "description": "User-facing label for this destination, used in routing references.", + "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" }, - "provided_aqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage", + "pay_per_token_config": { + "description": "Configuration for a pay-per-token Databricks foundation model.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfigPayPerTokenConfig", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" }, - "provided_pubsub": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", + "provisioned_throughput_config": { + "description": "Configuration for a provisioned-throughput Databricks foundation model.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfigProvisionedThroughputConfig", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" }, - "provided_sqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", + "traffic_percentage": { + "description": "Percentage of primary traffic sent to this destination, from 0 to 100.\nRequired when there is more than one primary destination, in which case the\nprimary percentages must sum to 100; a single primary destination receives\nall traffic. Fallback destinations are ordered and do not use this field.", + "$ref": "#/$defs/int", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "destination_type", + "name" + ] + }, + "catalog.ModelServiceConfigDestinationConfigDestinationType": { + "type": "string", + "description": "Backing-model category for a model service destination.", + "enum": [ + "DESTINATION_TYPE_PAY_PER_TOKEN_FOUNDATION_MODEL", + "DESTINATION_TYPE_PROVISIONED_THROUGHPUT_FOUNDATION_MODEL", + "DESTINATION_TYPE_EXTERNAL_FOUNDATION_MODEL" + ] + }, + "catalog.ModelServiceConfigExternalModelConfig": { + "type": "object", + "description": "Configuration for an external-foundation-model destination. Provider auth\nand provider-specific cloud configuration are owned by a separate, governed\nModelProviderService entity referenced via `model_provider_service`; the\nplatform resolves the provider at invocation time.", + "properties": { + "model_provider_service": { + "description": "Resource name of the governed ModelProviderService that owns provider\nauth and provider-specific configuration. The referenced\nModelProviderService also carries the provider type, so this message\ndoes not surface it directly.\nFormat: `model-provider-services/{catalog}.{schema}.{model_provider_service}`.\nEach `{...}` component is capped at 255 characters individually.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "target": { + "description": "Routing target for the destination: the provider-side model selected from\nthe referenced ModelProviderService's `targets` catalog, plus the unified\nAPI types the platform should translate to/from at request time.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigModelTargetConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "model_provider_service", + "target" + ] + }, + "catalog.ModelServiceConfigFallbackConfig": { + "type": "object", + "description": "Fallback routing applied after a primary destination fails. Fallback\ndestinations are tried in the listed order.", + "properties": { + "destinations": { + "description": "Fallback destinations, tried in the listed order. At most 5 are allowed.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfigDestinationConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" } }, "additionalProperties": false }, - "catalog.GcpPubsub": { + "catalog.ModelServiceConfigPayPerTokenConfig": { "type": "object", + "description": "Configuration for a pay-per-token foundation-model destination. Identifies\nthe foundation model by its UC resource name; the platform resolves it to a\nModel Serving endpoint at request time.", "properties": { - "subscription_name": { - "description": "The Pub/Sub subscription name in the format projects/{project}/subscriptions/{subscription name}.\nOnly required for provided_pubsub.", + "model": { + "description": "Resource name of the Unity Catalog model.\nFormat: `models/{catalog}.{schema}.{model}`.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.289.0" + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "model" + ] + }, + "catalog.ModelServiceConfigProvisionedThroughputConfig": { + "type": "object", + "description": "Configuration for a provisioned-throughput foundation-model destination.\nReferences a pre-existing Model Serving endpoint that serves the model;\nsizing (provisioned throughput, burst scaling, model version) is owned by\nthe Model Serving endpoint itself, not by this message.", + "properties": { + "model_serving_endpoint": { + "description": "Name of the backing Model Serving endpoint serving the provisioned-\nthroughput foundation model, in the form `serving-endpoints/{name}`. The\nsame Unity Catalog model can be served on multiple Model Serving endpoints\nwith different throughput, regions, or configurations. The caller selects\nthe endpoint to which this destination routes. The endpoint must exist at\ncreate time.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "model_serving_endpoint" + ] + }, + "catalog.ModelServiceConfigRoutingConfig": { + "type": "object", + "description": "Routing configuration for a model service, nesting destinations and\nfallback under a single sub-message.", + "properties": { + "destinations": { + "description": "Primary routing destinations. At most 10 are allowed. At least one is\nrequired on Create. On Update, provide this list when replacing the full\n`config` or updating `config.routing.destinations`; other granular routing\nupdates do not require resending destinations. The intermediate\n`config.routing` mask path is not supported.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfigDestinationConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "fallback": { + "description": "Fallback routing applied after a primary destination fails. Fallback\ndestinations are tried in the listed order.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfigFallbackConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" } }, "additionalProperties": false @@ -5318,7 +6144,62 @@ "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", "EXTERNAL_USE_SCHEMA", - "READ_METADATA" + "READ_METADATA", + "EXTERNAL_USE_LOCATION" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "[Public Preview]" ] }, "catalog.PrivilegeAssignment": { @@ -5339,6 +6220,66 @@ }, "additionalProperties": false }, + "catalog.RateLimit": { + "type": "object", + "description": "A rate limit applied to service requests. Leave `requests` or `tokens`\nunset to impose no limit on that dimension; set a value to cap that dimension\nwithin the renewal period.", + "properties": { + "key": { + "description": "Scope of the rate limit. Depending on this value, the limit applies to a\nprincipal, the service as a whole, or each user by default.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.RateLimitRateLimitKey", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "principal": { + "description": "Principal this limit applies to: user email, group name, or service\nprincipal application ID. Required when `key` applies to a user, group, or\nservice principal; otherwise it must be unset.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "renewal_period": { + "description": "Renewal period.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.RateLimitRateLimitRenewalPeriod", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "requests": { + "description": "Maximum requests allowed in one renewal period. Leave unset for no request\nlimit. Set to `0` to deny all requests.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + }, + "tokens": { + "description": "Maximum tokens allowed in one renewal period. Leave unset for no token\nlimit. Set to `0` to deny all requests.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.17.0" + } + }, + "additionalProperties": false, + "required": [ + "key", + "renewal_period" + ] + }, + "catalog.RateLimitRateLimitKey": { + "type": "string", + "description": "Scope key for a rate limit.", + "enum": [ + "RATE_LIMIT_KEY_USER", + "RATE_LIMIT_KEY_USER_GROUP", + "RATE_LIMIT_KEY_SERVICE_PRINCIPAL", + "RATE_LIMIT_KEY_SERVICE", + "RATE_LIMIT_KEY_USER_DEFAULT" + ] + }, + "catalog.RateLimitRateLimitRenewalPeriod": { + "type": "string", + "description": "Renewal period for a rate limit.", + "enum": [ + "RATE_LIMIT_RENEWAL_PERIOD_MINUTE", + "RATE_LIMIT_RENEWAL_PERIOD_HOUR" + ] + }, "catalog.RegisteredModelAlias": { "type": "object", "properties": { @@ -6161,12 +7102,14 @@ "enum": [ "GPU_1xA10", "GPU_8xH100", - "GPU_1xH100" + "GPU_1xH100", + "GPU_8xB300" ], "enumDescriptions": [ "[Beta]", "[Beta]", - "[Beta]" + "[Beta]", + "[Private Preview]" ] }, "compute.InitScriptInfo": { @@ -7215,6 +8158,13 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpecAcceleratorType", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" + }, + "provisioned_capacity_id": { + "description": "[Private Preview] Optional ID of a pre-provisioned accelerator capacity reservation to run\nthis AI Runtime workload on. When set, the workload is scheduled onto the\nreferenced reserved capacity instead of the on-demand capacity shared among\nall Databricks customers.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.17.0" } }, "additionalProperties": false, @@ -12237,7 +13187,7 @@ "x-since-version": "v0.287.0" }, "no_suspension": { - "description": "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.", + "description": "When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with `suspend_timeout_duration`.", "$ref": "#/$defs/bool", "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" @@ -12249,7 +13199,7 @@ "x-since-version": "v0.287.0" }, "suspend_timeout_duration": { - "description": "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.", + "description": "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`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", "x-databricks-launch-stage": "GA", "x-since-version": "v0.287.0" @@ -14328,6 +15278,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.JobRun" } }, + "resources.McpService": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.McpService" + } + }, "resources.MlflowExperiment": { "type": "object", "additionalProperties": { @@ -14340,6 +15296,18 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.MlflowModel" } }, + "resources.ModelProviderService": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ModelProviderService" + } + }, + "resources.ModelService": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ModelService" + } + }, "resources.ModelServingEndpoint": { "type": "object", "additionalProperties": { @@ -14633,6 +15601,18 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination" } }, + "catalog.ModelProviderServiceConfigModelTargetConfig": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigModelTargetConfig" + } + }, + "catalog.ModelServiceConfigDestinationConfig": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelServiceConfigDestinationConfig" + } + }, "catalog.MonitorMetric": { "type": "array", "items": { @@ -14651,6 +15631,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" } }, + "catalog.RateLimit": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.RateLimit" + } + }, "catalog.RegisteredModelAlias": { "type": "array", "items": { From 715d4def70646e60f6d3c9070380de4ff61371f6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 24 Sep 2026 12:12:02 +0000 Subject: [PATCH 23/31] Update jsonschema_for_docs.json for v1.18.0 --- bundle/schema/jsonschema_for_docs.json | 289 +++++++++++++++++++++---- 1 file changed, 252 insertions(+), 37 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 38e1214a799..b9d3bbfaff7 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -169,9 +169,9 @@ "x-since-version": "v0.283.0" }, "git_source": { - "description": "[Beta] 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.", + "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-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.290.0" }, "lifecycle": { @@ -198,9 +198,8 @@ "x-since-version": "v0.239.0" }, "source_code_path": { - "description": "[Beta]", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.239.0" }, "space": { @@ -211,9 +210,8 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" }, "usage_policy_id": { @@ -1238,7 +1236,7 @@ "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.", + "description": "A list of task execution environment specifications that can be referenced by tasks that use serverless compute or a compute resource that uses Environments mode.\n\nFor notebook tasks that use serverless compute or a compute resource that uses Environments mode, 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 tasks that use serverless compute or a compute resource that uses Environments mode, 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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" @@ -1298,7 +1296,7 @@ "x-since-version": "v1.7.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.", + "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* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `COST_OPTIMIZED`: Enables lower job costs by optimizing compute for your selected target duration time. Must provide a duration target.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PerformanceTarget", "x-databricks-launch-stage": "GA", "x-since-version": "v0.241.0" @@ -1457,7 +1455,7 @@ "x-since-version": "v1.7.0" }, "performance_target": { - "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\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.", + "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. This field overrides the performance target defined on the job level.\n\n* `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n* `COST_OPTIMIZED`: Enables lower job costs by optimizing compute for your selected target duration time. Must provide a duration target.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PerformanceTarget", "x-databricks-launch-stage": "GA", "x-since-version": "v1.7.0" @@ -2274,10 +2272,9 @@ "x-since-version": "v0.287.0" }, "source_snapshot": { - "description": "[Private Preview] The snapshot this branch was created from. When set, the branch's data\ncomes from the snapshot rather than a source branch, so source_branch,\nsource_branch_lsn, and source_branch_time must be empty. The snapshot must\nbe AVAILABLE and belong to this branch's project.\nFormat: projects/{project_id}/snapshots/{snapshot_id}", + "description": "[Beta] The snapshot this branch was created from. When set, the branch's data\ncomes from the snapshot rather than a source branch, so source_branch,\nsource_branch_lsn, and source_branch_time must be empty. The snapshot must\nbe AVAILABLE and belong to this branch's project.\nFormat: projects/{project_id}/snapshots/{snapshot_id}", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" }, "ttl": { @@ -4909,15 +4906,15 @@ "description": "Git repository configuration specifying the location of the repository.", "properties": { "auto_deploy": { - "description": "[Beta] When true, automatically deploys the app on push events to the branch configured in\nthe app's deployment_source.git_source.", + "description": "When true, automatically deploys the app on push events to the branch configured in\nthe app's deployment_source.git_source.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.14.0" }, "caller_credential_id": { - "description": "[Beta] ID of a personal access token Git credential owned by the caller, used to\ngrant the app's service principal access to this repository.", + "description": "ID of a personal access token Git credential owned by the caller, used to\ngrant the app's service principal access to this repository.", "$ref": "#/$defs/int64", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.14.0" }, "provider": { @@ -4975,9 +4972,9 @@ "description": "A single telemetry export destination with its configuration and status.", "properties": { "unity_catalog": { - "description": "[Public Preview] Unity Catalog Destinations for OTEL telemetry export.", + "description": "Unity Catalog Destinations for OTEL telemetry export.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.UnityCatalog", - "x-databricks-launch-stage": "PUBLIC_PREVIEW", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" } }, @@ -4988,21 +4985,21 @@ "description": "Unity Catalog Destinations for OTEL telemetry export.", "properties": { "logs_table": { - "description": "[Public Preview] Unity Catalog table for OTEL logs.", + "description": "Unity Catalog table for OTEL logs.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PUBLIC_PREVIEW", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" }, "metrics_table": { - "description": "[Public Preview] Unity Catalog table for OTEL metrics.", + "description": "Unity Catalog table for OTEL metrics.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PUBLIC_PREVIEW", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" }, "traces_table": { - "description": "[Public Preview] Unity Catalog table for OTEL traces (spans).", + "description": "Unity Catalog table for OTEL traces (spans).", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PUBLIC_PREVIEW", + "x-databricks-launch-stage": "GA", "x-since-version": "v0.294.0" } }, @@ -5457,6 +5454,27 @@ }, "additionalProperties": false }, + "catalog.ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth": { + "type": "object", + "description": "Header-based API-key authentication for a custom provider: the secret is\nforwarded on outbound requests under a caller-chosen HTTP header, as\n`\u003capi_key_name\u003e: \u003capi_key_value\u003e`.", + "properties": { + "api_key_name": { + "description": "[Private Preview] HTTP header name that carries the API key on outbound requests (e.g.,\n`Ocp-Apim-Subscription-Key`). The value forwarded under this header is\nsupplied via `api_key_value`.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "api_key_value": { + "description": "[Private Preview] Secret value forwarded under the `api_key_name` header on outbound\nrequests. Supplied as inline plaintext via `ProviderSecret.plaintext`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + } + }, + "additionalProperties": false + }, "catalog.ModelProviderServiceConfigCustomProviderConfig": { "type": "object", "description": "Custom OpenAI-compatible provider configuration with bearer-token\nauthentication.", @@ -5472,7 +5490,7 @@ }, "catalog.ModelProviderServiceConfigCustomProviderDirectConfig": { "type": "object", - "description": "Direct form of a custom provider configuration. Set `api_key` to the bearer\ntoken sent in the `Authorization` header.", + "description": "Direct form of a custom provider configuration. Set `api_key` to send the\nsecret as an `Authorization` bearer token, or `header_auth` to forward it\nunder a caller-chosen HTTP header.", "properties": { "api_key": { "description": "Bearer token forwarded in the `Authorization` header. Supply the value\nin `api_key.plaintext`.", @@ -5485,6 +5503,13 @@ "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" + }, + "header_auth": { + "description": "[Private Preview] Header-based API-key auth: the secret is forwarded on outbound requests\nunder a caller-chosen HTTP header rather than as an `Authorization`\nbearer token. Set this instead of `api_key` for header auth.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" } }, "additionalProperties": false @@ -7063,7 +7088,7 @@ "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.", + "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\nDatabricks 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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" @@ -7991,6 +8016,20 @@ "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" + }, + "priority_class": { + "description": "[Private Preview] Scheduling priority class for the workload. May only be set together with\na pre-provisioned capacity reservation (a deployment's\n`compute.provisioned_capacity_id`); it is rejected on a workload that runs\non on-demand capacity.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiRuntimeTaskPriorityClass", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "unity_catalog_image_path": { + "description": "[Private Preview] Optional Unity Catalog path for a custom container image. When set,\nthe task runs on the specified container image instead of the default\nDatabricks client image. Format:\n`{catalog}.{schema}.{image_name}:{tag}`", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" } }, "additionalProperties": false, @@ -7999,6 +8038,20 @@ "experiment" ] }, + "jobs.AiRuntimeTaskPriorityClass": { + "type": "string", + "description": "Scheduling priority class for a workload — its priority and preemptability\nwhen the scheduler ranks pending work.", + "enum": [ + "BEST_EFFORT", + "NORMAL", + "CRITICAL" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, "jobs.AlertTask": { "type": "object", "properties": { @@ -8179,9 +8232,11 @@ "enum": [ "GPU_1xA10", "GPU_1xH100", - "GPU_8xH100" + "GPU_8xH100", + "GPU_8xB300" ], "enumDescriptions": [ + "[Public Preview]", "[Public Preview]", "[Public Preview]", "[Public Preview]" @@ -8349,10 +8404,9 @@ "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\\\"}\"`)", + "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" }, "subscription": { @@ -8903,13 +8957,12 @@ }, "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.", + "description": "Write-only setting. Specifies the user, service principal, or group that the job runs as. If not specified, the job runs as the user who created the job.\n\nOne of `user_name`, `service_principal_name`, or `group_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.", + "description": "Group name of an account group assigned to the workspace. When set, all tasks run as the group and the group's permissions are used for data access. Setting this field requires being a member of the group, or having the `Assume` permission on the group.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, "service_principal_name": { @@ -10073,7 +10126,7 @@ "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.", + "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 or a compute resource that uses Environments mode.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" @@ -10639,6 +10692,40 @@ "enabled" ] }, + "pipelines.AvroTransformerOptions": { + "type": "object", + "properties": { + "parse_mode": { + "description": "[Private Preview] (Optional) Parse mode for Avro data.\nValid values: FAILFAST, PERMISSIVE. Defaults to FAILFAST.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ParseMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "schema": { + "description": "[Private Preview] Inline Avro JSON schema string.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "schema_file_path": { + "description": "[Private Preview] Path to a schema file (.avsc).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "schema_registry": { + "description": "[Private Preview] (Optional) Schema registry to resolve the Avro schema at runtime instead of\nproviding it inline or via a file path.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaRegistryConfig", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + } + }, + "additionalProperties": false + }, "pipelines.ConfluenceConnectorOptions": { "type": "object", "description": "Confluence specific options for ingestion", @@ -10652,6 +10739,19 @@ }, "additionalProperties": false }, + "pipelines.ConfluentSchemaRegistryOptions": { + "type": "object", + "properties": { + "subject": { + "description": "[Private Preview] Required: subject name to resolve in the registry.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + } + }, + "additionalProperties": false + }, "pipelines.ConnectionParameters": { "type": "object", "properties": { @@ -11461,7 +11561,9 @@ "JIRA", "CONFLUENCE", "META_MARKETING", + "TIKTOK_ADS", "ZENDESK", + "SMARTSHEET", "RABBITMQ", "FOREIGN_CATALOG" ], @@ -11484,7 +11586,9 @@ "[Beta]", "[Public Preview]", "[Beta]", + "[Private Preview]", "[Public Preview]", + "[Private Preview]", "[Beta]", "[Private Preview]" ] @@ -12008,6 +12112,18 @@ }, "additionalProperties": false }, + "pipelines.ParseMode": { + "type": "string", + "description": "Determines how errors encountered while deserializing records are handled.", + "enum": [ + "FAILFAST", + "PERMISSIVE" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" + ] + }, "pipelines.PathPattern": { "type": "object", "properties": { @@ -12320,6 +12436,47 @@ }, "additionalProperties": false }, + "pipelines.ProtobufTransformerOptions": { + "type": "object", + "properties": { + "desc_file_path": { + "description": "[Private Preview] Required: path to the .desc file (dbfs:/... or /Volumes/...).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "message_name": { + "description": "[Private Preview] Required: fully-qualified message type name.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "parse_mode": { + "description": "[Private Preview] (Optional) Parse mode for Protobuf data.\nValid values: FAILFAST, PERMISSIVE. Defaults to FAILFAST.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ParseMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "recursive_fields_max_depth": { + "description": "[Private Preview] (Optional) Maximum expansion depth for recursive protobuf fields.\nSpark SQL does not natively support recursive types, so recursive\nfields are expanded up to this depth and truncated beyond it.\nValid values: -1 (disallow recursive fields), 0 (drop), 1-10.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "schema_registry": { + "description": "[Private Preview] (Optional) Schema registry to resolve the Protobuf schema at runtime instead\nof providing it via desc_file_path.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaRegistryConfig", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + } + }, + "additionalProperties": false + }, "pipelines.RabbitmqOptions": { "type": "object", "description": "RabbitMQ specific options for ingestion.\nPerformance tuning options (consumers_per_task, max_messages_per_fetch, etc.)\nare intentionally not exposed in the public API. The managed connector uses\nsensible defaults internally. These can be added later if user demand arises.", @@ -12460,6 +12617,13 @@ "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": { + "group_name": { + "description": "[Private Preview] Group name of an account group assigned to the workspace. When set, the pipeline runs as the group and the group's permissions are used for data access. Setting this field requires being a member of the group, or having the `Assume` permission on the group.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, "service_principal_name": { "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", "$ref": "#/$defs/string", @@ -12475,6 +12639,33 @@ }, "additionalProperties": false }, + "pipelines.SchemaRegistryConfig": { + "type": "object", + "properties": { + "confluent_options": { + "description": "[Private Preview] Required: Confluent-compatible schema registry options.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluentSchemaRegistryOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "connection_name": { + "description": "[Private Preview] (Optional) UC connection for registry authentication.\nSpecify if different from the top-level source connection.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, + "protobuf_message_name": { + "description": "[Private Preview] (Optional, Protobuf only) Selects a specific message from a schema that\ndefines multiple Protobuf messages. Simple (\"Location\") or fully-qualified\n(\"com.example.protos.Location\"). Defaults to the first message.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + } + }, + "additionalProperties": false + }, "pipelines.SchemaSpec": { "type": "object", "properties": { @@ -12947,6 +13138,13 @@ "type": "object", "description": "Specifies how to transform binary data into structured data.", "properties": { + "avro_options": { + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AvroTransformerOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" + }, "format": { "description": "[Beta] Required: the wire format of the data.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", @@ -12972,6 +13170,13 @@ "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.13.0" + }, + "protobuf_options": { + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ProtobufTransformerOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.18.0" } }, "additionalProperties": false @@ -12980,11 +13185,15 @@ "type": "string", "enum": [ "STRING", - "JSON" + "JSON", + "AVRO", + "PROTOBUF" ], "enumDescriptions": [ "[Beta]", - "[Beta]" + "[Beta]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.ZendeskSupportOptions": { @@ -13695,6 +13904,12 @@ "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v0.243.0" + }, + "uc_service_credential_name": { + "description": "[Public Preview] The name of the Unity Catalog service credential that the external model uses to access AWS\nresources.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", + "x-since-version": "v1.18.0" } }, "additionalProperties": false, From 54f5701b3c8bba281a399ece74a5a1a1b89090ec Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 30 Sep 2026 13:01:17 +0000 Subject: [PATCH 24/31] Update jsonschema_for_docs.json for v1.19.0 --- bundle/schema/jsonschema_for_docs.json | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index b9d3bbfaff7..5aa833a3cc8 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -506,6 +506,11 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.237.0" }, + "libraries": { + "description": "A list of libraries to install on the cluster. Installed via the Libraries API after the cluster is created. Only supported in direct deployment mode.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.Library", + "x-since-version": "v1.19.0" + }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", @@ -2601,6 +2606,7 @@ }, "resources.PostgresSnapshotSchedule": { "type": "object", + "description": "[Beta]", "properties": { "branch": { "description": "The branch whose automatic-snapshot schedule this manages. Format: projects/{project_id}/branches/{branch_id}", @@ -2621,7 +2627,8 @@ "additionalProperties": false, "required": [ "branch" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, "resources.PostgresSyncedTable": { "type": "object", From 15972a282b108508a4fc69aae230e6729e7b684d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 7 Oct 2026 12:12:31 +0000 Subject: [PATCH 25/31] Update jsonschema_for_docs.json for v1.20.0 --- bundle/schema/jsonschema_for_docs.json | 453 ++++++++++++++----------- 1 file changed, 264 insertions(+), 189 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 5aa833a3cc8..732253e7563 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -14,11 +14,9 @@ "engine.EngineType": { "type": "string", "enum": [ - "terraform", "direct" ], "enumDescriptions": [ - "Deploy through Terraform. Deprecated: Migrate to `direct`, see https://docs.databricks.com/aws/en/dev-tools/bundles/direct", "Deploy by calling the Databricks APIs directly. This is the default." ] }, @@ -127,17 +125,15 @@ "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`.", + "description": "Maximum number of app instances the app is configured to run. Must be set together with `compute_min_instances`.", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "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`.", + "description": "Minimum number of app instances the app is configured to run. Must be set together with `compute_max_instances`.", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.2.0" }, "compute_size": { @@ -507,7 +503,7 @@ "x-since-version": "v0.237.0" }, "libraries": { - "description": "A list of libraries to install on the cluster. Installed via the Libraries API after the cluster is created. Only supported in direct deployment mode.", + "description": "A list of libraries to install on the cluster. Installed via the Libraries API after the cluster is created.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.Library", "x-since-version": "v1.19.0" }, @@ -1240,6 +1236,12 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, + "environment_variables": { + "description": "[Beta] Named environment-variable entries that tasks can reference by key from\n`TaskSettings.environment_variables_key`. Each entry's `spec` holds inline\n`variables` and optional `.env` `files`. Maximum 10 entries per job. A task\ncan reference at most one entry from this list.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironmentVariables", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.20.0" + }, "environments": { "description": "A list of task execution environment specifications that can be referenced by tasks that use serverless compute or a compute resource that uses Environments mode.\n\nFor notebook tasks that use serverless compute or a compute resource that uses Environments mode, 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 tasks that use serverless compute or a compute resource that uses Environments mode, 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", @@ -1571,7 +1573,7 @@ "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.", + "description": "Lifecycle setting to deploy the resource in started mode. Only supported for apps, clusters, and sql_warehouses.", "$ref": "#/$defs/bool", "x-since-version": "v0.297.0" } @@ -2016,10 +2018,12 @@ "deprecated": true }, "development": { - "description": "Whether the pipeline is in Development mode. Defaults to false.", + "description": "Whether the pipeline is in Development mode. Defaults to false.\n\nDeprecated: set development mode for each update instead.", "$ref": "#/$defs/bool", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.229.0" + "deprecationMessage": "This field is deprecated", + "x-since-version": "v0.229.0", + "deprecated": true }, "edition": { "description": "Pipeline product edition.", @@ -3718,7 +3722,7 @@ "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 \"direct\".", + "description": "The deployment engine to use. Valid values are `direct`. Takes priority over `DATABRICKS_BUNDLE_ENGINE` environment variable. Default is \"direct\".", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/engine.EngineType", "x-since-version": "v0.295.0" }, @@ -5466,17 +5470,15 @@ "description": "Header-based API-key authentication for a custom provider: the secret is\nforwarded on outbound requests under a caller-chosen HTTP header, as\n`\u003capi_key_name\u003e: \u003capi_key_value\u003e`.", "properties": { "api_key_name": { - "description": "[Private Preview] HTTP header name that carries the API key on outbound requests (e.g.,\n`Ocp-Apim-Subscription-Key`). The value forwarded under this header is\nsupplied via `api_key_value`.", + "description": "HTTP header name that carries the API key on outbound requests (e.g.,\n`Ocp-Apim-Subscription-Key`). The value forwarded under this header is\nsupplied via `api_key_value`.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.18.0" }, "api_key_value": { - "description": "[Private Preview] Secret value forwarded under the `api_key_name` header on outbound\nrequests. Supplied as inline plaintext via `ProviderSecret.plaintext`.", + "description": "Secret value forwarded under the `api_key_name` header on outbound\nrequests. Supplied as inline plaintext via `ProviderSecret.plaintext`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderSecret", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.18.0" } }, @@ -5512,10 +5514,9 @@ "x-since-version": "v1.17.0" }, "header_auth": { - "description": "[Private Preview] Header-based API-key auth: the secret is forwarded on outbound requests\nunder a caller-chosen HTTP header rather than as an `Authorization`\nbearer token. Set this instead of `api_key` for header auth.", + "description": "Header-based API-key auth: the secret is forwarded on outbound requests\nunder a caller-chosen HTTP header rather than as an `Authorization`\nbearer token. Set this instead of `api_key` for header auth.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.18.0" } }, @@ -5593,6 +5594,12 @@ "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" + }, + "service_credential": { + "description": "Reference to a Unity Catalog service credential authorizing Gemini\nEnterprise requests. On Create, supply `service_credential.name` as\n`credentials/{name}`; required when using service-credential\nauthentication and mutually exclusive with `api_key`. The credential is\nreferenced by name; its value is not carried here. On read, the resolved\n`id` and `is_deleted` are also populated. Supported only on GCP-hosted\nworkspaces.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigServiceCredential", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.20.0" } }, "additionalProperties": false @@ -5710,10 +5717,32 @@ "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" + }, + "secret_reference": { + "description": "Reference to a customer-owned UC Secret that carries this secret value.\nThe value is read at invoke time under the model provider service\nowner's access and is never copied onto the model provider service, so\nrotating the UC Secret takes effect with no change to the model provider\nservice. On Create, supply `secret_reference.name` as\n`secrets/{catalog}.{schema}.{secret}`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigSecretReference", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.20.0" } }, "additionalProperties": false }, + "catalog.ModelProviderServiceConfigSecretReference": { + "type": "object", + "description": "Reference to a customer-owned UC Secret backing a secret-bearing provider\nfield, in the `ProviderSecret.secret_reference` arm.", + "properties": { + "name": { + "description": "Resource name of the bound UC Secret, in the form\n`secrets/{catalog}.{schema}.{secret}`. On Create the caller supplies the\nname here. On read it reflects the secret's current name at read time.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.20.0" + } + }, + "additionalProperties": false, + "required": [ + "name" + ] + }, "catalog.ModelProviderServiceConfigServiceCredential": { "type": "object", "description": "The customer-owned Unity Catalog service credential a model provider service\nuses to authenticate to its provider, referenced by name.", @@ -7041,6 +7070,12 @@ "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "GA", "x-since-version": "v0.271.0" + }, + "project_environment": { + "description": "[Beta] File path of pyproject.toml file that defines the project-scoped environment.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.20.0" } }, "additionalProperties": false @@ -7138,10 +7173,10 @@ "GPU_8xB300" ], "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]", - "[Private Preview]" + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "compute.InitScriptInfo": { @@ -7200,7 +7235,7 @@ "description": "Attributes set during instance pool creation which are related to Amazon Web Services.", "properties": { "availability": { - "description": "Availability type used for the spot nodes.", + "description": "Availability type used for the instances in the pool. Supports on-demand, spot, and\nspot-with-fallback (the pool acquires spot instances first, and falls back to on-demand\ninstances when spot capacity is unavailable).\n\nYou can change this value on an existing pool. New clusters use the updated availability, and\nexisting clusters keep the availability they launched with.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAwsAttributesAvailability", "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" @@ -7212,13 +7247,13 @@ "x-since-version": "v1.9.0" }, "spot_bid_price_percent": { - "description": "Calculates 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.", + "description": "Calculates 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.\n\nYou can change this value on an existing pool. New clusters use the updated bid price, and\nexisting clusters keep the bid price they launched with.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.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, a default zone will be used.\nThe list of available zones as well as the default value can be found by using the\n`List Zones` method.", + "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, a default zone will be used.\nThe list of available zones as well as the default value can be found by using the\n`List Zones` method.\n\nSet this field to \"auto\" to enable Auto-AZ, in which case Databricks selects the availability\nzone for each cluster independently when the cluster launches, and retries another zone if the\ncluster can't be fulfilled because of insufficient capacity or quota. All nodes in a cluster\nland in the same zone, and different clusters backed by the pool can run in different zones.\n\nYou can change the zone on an existing pool. New clusters use the updated zone, and existing\nclusters keep the zone they launched with.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" @@ -7239,7 +7274,7 @@ "description": "Attributes set during instance pool creation which are related to Azure.", "properties": { "availability": { - "description": "Availability type used for the spot nodes.", + "description": "Availability type used for the instances in the pool. Supports on-demand, spot, and\nspot-with-fallback (the pool acquires spot instances first, and falls back to on-demand\ninstances when spot capacity is unavailable).\n\nYou can change this value on an existing pool. New clusters use the updated availability, and\nexisting clusters keep the availability they launched with.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAzureAttributesAvailability", "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" @@ -7251,7 +7286,7 @@ "x-since-version": "v1.9.0" }, "spot_bid_max_price": { - "description": "With variable pricing, you have option to set a max price, in US dollars (USD)\nFor example, the value 2 would be a max price of $2.00 USD per hour.\nIf you set the max price to be -1, the VM won't be evicted based on price.\nThe price for the VM will be the current price for spot or the price for a standard VM,\nwhich ever is less, as long as there is capacity and quota available.", + "description": "With variable pricing, you have option to set a max price, in US dollars (USD)\nFor example, the value 2 would be a max price of $2.00 USD per hour.\nIf you set the max price to be -1, the VM won't be evicted based on price.\nThe price for the VM will be the current price for spot or the price for a standard VM,\nwhich ever is less, as long as there is capacity and quota available.\n\nYou can change this value on an existing pool. New clusters use the updated max price, and\nexisting clusters keep the max price they launched with.", "$ref": "#/$defs/float64", "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" @@ -7272,7 +7307,7 @@ "description": "Attributes set during instance pool creation which are related to GCP.", "properties": { "gcp_availability": { - "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.", + "description": "Availability type for the instances in the pool. One of:\n\n- `ON_DEMAND_GCP`: the pool uses on-demand instances only.\n- `PREEMPTIBLE_GCP`: the pool uses preemptible instances only.\n- `PREEMPTIBLE_WITH_FALLBACK_GCP`: the pool acquires preemptible instances first, and falls\nback to on-demand instances when preemptible capacity is unavailable.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability", "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" @@ -7284,7 +7319,7 @@ "x-since-version": "v1.9.0" }, "zone_id": { - "description": "Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west1-a\". The provided availability\nzone must be in the same region as the Databricks workspace. For example, \"us-west1-a\"\nis not a valid zone id if the Databricks workspace resides in the \"us-east1\" region.\nThis is an optional field at instance pool creation, and if not specified, a default zone will be used.\n\nThis field can be one of the following:\n- \"HA\" =\u003e High availability, spread nodes across availability zones for a Databricks deployment region\n- A GCP availability zone =\u003e Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones (e.g. \"us-west1-a\").\n\nIf empty, Databricks picks an availability zone to schedule the cluster on.", + "description": "Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west1-a\". The provided availability\nzone must be in the same region as the Databricks workspace. For example, \"us-west1-a\"\nis not a valid zone id if the Databricks workspace resides in the \"us-east1\" region.\nThis is an optional field at instance pool creation, and if not specified, a default zone will be used.\n\nThis field can be one of the following:\n- \"HA\" =\u003e High availability, spread nodes across availability zones for a Databricks deployment region\n- \"auto\" =\u003e Auto-AZ. Databricks selects the availability zone for each cluster independently when the cluster launches, and retries another zone if the cluster can't be fulfilled because of insufficient capacity or quota. All nodes in a cluster land in the same zone, and different clusters backed by the pool can run in different zones.\n- A GCP availability zone =\u003e Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones (e.g. \"us-west1-a\").\n\nIf empty, Databricks picks an availability zone to schedule the cluster on.\n\nYou can change the zone on an existing pool. New clusters use the updated zone, and existing\nclusters keep the zone they launched with.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" @@ -8165,9 +8200,9 @@ "type": "object", "properties": { "hardware_accelerator": { - "description": "[Beta] Hardware accelerator configuration for Serverless GPU workloads.", + "description": "[Public Preview] Hardware accelerator configuration for Serverless GPU workloads.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.288.0" } }, @@ -8301,10 +8336,9 @@ "type": "object", "properties": { "maintenance_window": { - "description": "[Private Preview] Defines when platform-initiated maintenance may run for this job. If unspecified, maintenance may run at any time.", + "description": "Defines when platform-initiated maintenance may run for this job. If unspecified, maintenance may run at any time.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.MaintenanceWindow", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" }, "pause_status": { @@ -8327,10 +8361,9 @@ "description": "Continuous trigger. Stripped-down counterpart to `ContinuousSettings`: `pause_status` is owned by the enclosing\n`TriggerConfiguration` and intentionally omitted here.", "properties": { "maintenance_window": { - "description": "[Private Preview] Defines when platform-initiated maintenance may run for this trigger. If unspecified,\nmaintenance may run at any time.", + "description": "[Beta] Defines when platform-initiated maintenance may run for this trigger. If unspecified,\nmaintenance may run at any time.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.MaintenanceWindow", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" }, "task_retry_mode": { @@ -8442,15 +8475,6 @@ "FRIDAY", "SATURDAY", "SUNDAY" - ], - "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" ] }, "jobs.DbtCloudTask": { @@ -8550,7 +8574,7 @@ "description": "DeploymentSpec: configuration for one deployment within an AiRuntimeTask.\nEach entry in `AiRuntimeTask.deployments` describes a group of nodes that\nshare the same command and compute. Many single-program training\nalgorithms use a single entry where every node runs the same command;\nrole-split workloads (driver + worker, parameter server, separate eval\nnode, etc.) use multiple entries.", "properties": { "command_path": { - "description": "[Public Preview] Workspace path of the script to run on each node in this deployment.\nUpload the script to this path and supply the path here. When the task\nruns, the file at this path is run on each node; if it fails, the task\nfails with its exit code.\n\nExample script contents:\n\n# Plain Python:\npython train.py --epochs 10\n\n# Multi-GPU via accelerate:\naccelerate launch train.py --config config.yaml\n\n# Distributed via torchrun:\ntorchrun --nproc_per_node=8 train.py", + "description": "[Public Preview] Workspace path of the script to run on each node in this deployment.\nUpload the script to this path and supply the path here. When the task\nruns, the file at this path is run on each node; if it fails, the task\nfails with its exit code.\n\nExample script contents:\n\n```bash\n# Plain Python:\npython train.py --epochs 10\n\n# Multi-GPU via accelerate:\naccelerate launch train.py --config config.yaml\n\n# Distributed via torchrun:\ntorchrun --nproc_per_node=8 train.py\n```", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.6.0" @@ -8570,7 +8594,6 @@ }, "additionalProperties": false, "required": [ - "command_path", "compute" ] }, @@ -8870,6 +8893,18 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, + "on_maintenance_complete": { + "description": "A list of email addresses to notify when platform-initiated maintenance completes for a continuous job.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.20.0" + }, + "on_maintenance_start": { + "description": "A list of email addresses to notify when platform-initiated maintenance starts for a continuous job.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.20.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", @@ -8912,6 +8947,47 @@ "environment_key" ] }, + "jobs.JobEnvironmentVariables": { + "type": "object", + "description": "A named environment-variable entry, defined once at the job level and\nreferenced by key from one or more tasks. Entries live on\n`JobSettings.environment_variables`, and tasks select one via\n`TaskSettings.environment_variables_key`.", + "properties": { + "environment_variables_key": { + "description": "[Beta] Identifier for this entry. Must be unique within\n`JobSettings.environment_variables`. Tasks reference it from\n`TaskSettings.environment_variables_key`.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.20.0" + }, + "spec": { + "description": "[Beta] The environment variable specification.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironmentVariablesSpec", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.20.0" + } + }, + "additionalProperties": false, + "required": [ + "environment_variables_key" + ] + }, + "jobs.JobEnvironmentVariablesSpec": { + "type": "object", + "description": "The environment variables and files associated with a job environment\nvariable entry. Runtime environment variables override inline `variables`,\nwhich override values from `files`, on duplicate keys.", + "properties": { + "files": { + "description": "[Beta] Workspace (`/Workspace/...`) or UC Volumes (`/Volumes/...`) paths to\n`.env` files. Maximum 5 files. Files are read, parsed, and merged at\ntask execution time, not at job creation or update API call time.\n\nFile format: each line containing a variable must be exactly `KEY=VALUE`.\nEmpty and whitespace-only lines, and lines beginning with `#`, are ignored.\nKeys must match the same regex as inlined variable names\n(`^[A-Za-z_][A-Za-z0-9_]*$`); the value continues to the end of the line.\nNo other syntax is supported — no inline comments, no quoted values, no\nescape sequences, no variable interpolation. Any other line that does not\nmatch the `KEY=VALUE` shape fails the run.\n\nSize limits: maximum 32,768 bytes (32 KiB) per file on disk;\nmaximum 1,024 bytes (1 KiB) per `KEY=VALUE` line combined.\nFiles or lines exceeding these limits fail the run.\n\nOn a duplicate key, the later file wins; `variables` override values\nfrom any file.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.20.0" + }, + "variables": { + "description": "[Beta] Environment variables specified directly as key/value pairs. Maximum 20\nentries.\n\nEach key must be 1 to 256 characters and match\n`^[A-Za-z_][A-Za-z0-9_]*$`: it must start with an ASCII letter or\nunderscore and contain only ASCII letters, digits, and underscores. Each\nvalue can be any Unicode string of up to 512 characters, including an\nempty string.", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.20.0" + } + }, + "additionalProperties": false + }, "jobs.JobNotificationSettings": { "type": "object", "properties": { @@ -9102,24 +9178,21 @@ "description": "A recurring weekly time window during which platform-initiated maintenance is\nallowed to run for a continuous job.", "properties": { "day_of_week": { - "description": "[Private Preview] The day of week on which maintenance is allowed to happen. This field is required.", + "description": "The day of week on which maintenance is allowed to happen. This field is required.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DayOfWeek", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" }, "start_hour": { - "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the maintenance window in the 24-hour day.\nPlatform-initiated maintenance is triggered only within a one-hour window starting at this hour.\nThis field is required.", + "description": "An integer between 0 and 23 denoting the start hour for the maintenance window in the 24-hour day.\nPlatform-initiated maintenance is triggered only within a one-hour window starting at this hour.\nThis field is required.", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" }, "timezone_id": { - "description": "[Private Preview] A Java timezone ID. The maintenance window 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.", + "description": "A Java timezone ID. The maintenance window 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-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" } }, @@ -10063,9 +10136,9 @@ "x-since-version": "v0.237.0" }, "compute": { - "description": "[Beta] Task level compute configuration.", + "description": "[Public Preview] Task level compute configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.288.0" }, "condition_task": { @@ -10138,6 +10211,12 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, + "environment_variables_key": { + "description": "[Beta] Reference to a `JobEnvironmentVariables` entry defined in\n`JobSettings.environment_variables`. The selected entry's variables are\napplied to this task at execution time. This field supports serverless\ntasks using environment version 5 or later.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.20.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", @@ -10342,6 +10421,18 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, + "on_maintenance_complete": { + "description": "A list of email addresses to notify when platform-initiated maintenance completes for a continuous job.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.20.0" + }, + "on_maintenance_start": { + "description": "A list of email addresses to notify when platform-initiated maintenance starts for a continuous job.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.20.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", @@ -10524,6 +10615,18 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, + "on_maintenance_complete": { + "description": "An optional list of system notification IDs to call when platform-initiated maintenance completes for a continuous job.\nA maximum of 3 destinations can be specified for the `on_maintenance_complete` property.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.20.0" + }, + "on_maintenance_start": { + "description": "An optional list of system notification IDs to call when platform-initiated maintenance starts for a continuous job.\nA maximum of 3 destinations can be specified for the `on_maintenance_start` property.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.20.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", @@ -10703,31 +10806,27 @@ "type": "object", "properties": { "parse_mode": { - "description": "[Private Preview] (Optional) Parse mode for Avro data.\nValid values: FAILFAST, PERMISSIVE. Defaults to FAILFAST.", + "description": "[Beta] (Optional) Parse mode for Avro data.\nValid values: FAILFAST, PERMISSIVE. Defaults to PERMISSIVE.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ParseMode", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "schema": { - "description": "[Private Preview] Inline Avro JSON schema string.", + "description": "[Beta] Inline Avro JSON schema string.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "schema_file_path": { - "description": "[Private Preview] Path to a schema file (.avsc).", + "description": "[Beta] Path to a schema file (.avsc).", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "schema_registry": { - "description": "[Private Preview] (Optional) Schema registry to resolve the Avro schema at runtime instead of\nproviding it inline or via a file path.", + "description": "[Beta] (Optional) Schema registry to resolve the Avro schema at runtime instead of\nproviding it inline or via a file path.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaRegistryConfig", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" } }, @@ -10750,10 +10849,9 @@ "type": "object", "properties": { "subject": { - "description": "[Private Preview] Required: subject name to resolve in the registry.", + "description": "[Beta] Required: subject name to resolve in the registry.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" } }, @@ -10863,17 +10961,15 @@ "x-since-version": "v0.298.0" }, "smartsheet_options": { - "description": "[Private Preview] Smartsheet specific options for ingestion", + "description": "[Beta] 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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "tiktok_ads_options": { - "description": "[Private Preview] TikTok Ads specific options for ingestion", + "description": "[Beta] 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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.298.0" }, "zendesk_support_options": { @@ -11593,9 +11689,9 @@ "[Beta]", "[Public Preview]", "[Beta]", - "[Private Preview]", + "[Beta]", "[Public Preview]", - "[Private Preview]", + "[Beta]", "[Beta]", "[Private Preview]" ] @@ -12127,8 +12223,8 @@ "PERMISSIVE" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]" ] }, "pipelines.PathPattern": { @@ -12447,38 +12543,33 @@ "type": "object", "properties": { "desc_file_path": { - "description": "[Private Preview] Required: path to the .desc file (dbfs:/... or /Volumes/...).", + "description": "[Beta] Required: path to the .desc file (dbfs:/... or /Volumes/...).", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "message_name": { - "description": "[Private Preview] Required: fully-qualified message type name.", + "description": "[Beta] Required: fully-qualified message type name.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "parse_mode": { - "description": "[Private Preview] (Optional) Parse mode for Protobuf data.\nValid values: FAILFAST, PERMISSIVE. Defaults to FAILFAST.", + "description": "[Beta] (Optional) Parse mode for Protobuf data.\nValid values: FAILFAST, PERMISSIVE. Defaults to PERMISSIVE.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ParseMode", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "recursive_fields_max_depth": { - "description": "[Private Preview] (Optional) Maximum expansion depth for recursive protobuf fields.\nSpark SQL does not natively support recursive types, so recursive\nfields are expanded up to this depth and truncated beyond it.\nValid values: -1 (disallow recursive fields), 0 (drop), 1-10.", + "description": "[Beta] (Optional) Maximum expansion depth for recursive protobuf fields.\nSpark SQL does not natively support recursive types, so recursive\nfields are expanded up to this depth and truncated beyond it.\nValid values: -1 (disallow recursive fields), 0 (drop), 1-10.", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "schema_registry": { - "description": "[Private Preview] (Optional) Schema registry to resolve the Protobuf schema at runtime instead\nof providing it via desc_file_path.", + "description": "[Beta] (Optional) Schema registry to resolve the Protobuf schema at runtime instead\nof providing it via desc_file_path.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaRegistryConfig", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" } }, @@ -12650,24 +12741,21 @@ "type": "object", "properties": { "confluent_options": { - "description": "[Private Preview] Required: Confluent-compatible schema registry options.", + "description": "[Beta] Required: Confluent-compatible schema registry options.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluentSchemaRegistryOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "connection_name": { - "description": "[Private Preview] (Optional) UC connection for registry authentication.\nSpecify if different from the top-level source connection.", + "description": "[Beta] (Optional) UC connection for registry authentication.\nSpecify if different from the top-level source connection.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "protobuf_message_name": { - "description": "[Private Preview] (Optional, Protobuf only) Selects a specific message from a schema that\ndefines multiple Protobuf messages. Simple (\"Location\") or fully-qualified\n(\"com.example.protos.Location\"). Defaults to the first message.", + "description": "[Beta] (Optional, Protobuf only) Selects a specific message from a schema that\ndefines multiple Protobuf messages. Simple (\"Location\") or fully-qualified\n(\"com.example.protos.Location\"). Defaults to the first message.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" } }, @@ -12772,10 +12860,9 @@ "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.", + "description": "[Beta] (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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" } }, @@ -13002,62 +13089,55 @@ "x-since-version": "v1.9.0" }, "data_level": { - "description": "[Private Preview] Deprecated. Use custom_report_options.data_level instead.", + "description": "[Beta] 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", + "x-databricks-launch-stage": "PUBLIC_BETA", "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.", + "description": "[Beta] Deprecated. Use custom_report_options.dimensions instead.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "x-databricks-launch-stage": "PUBLIC_BETA", "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.", + "description": "[Beta] (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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.298.0" }, "metrics": { - "description": "[Private Preview] Deprecated. Use custom_report_options.metrics instead.", + "description": "[Beta] Deprecated. Use custom_report_options.metrics instead.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "x-databricks-launch-stage": "PUBLIC_BETA", "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.", + "description": "[Beta] Deprecated. Use custom_report_options.query_lifetime instead.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "x-databricks-launch-stage": "PUBLIC_BETA", "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.", + "description": "[Beta] 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", + "x-databricks-launch-stage": "PUBLIC_BETA", "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.", + "description": "[Beta] (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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.298.0" } }, @@ -13115,10 +13195,10 @@ "AUCTION_AD" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]" ] }, "pipelines.TikTokAdsOptionsTikTokReportType": { @@ -13133,12 +13213,12 @@ "GMV_MAX" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]" ] }, "pipelines.Transformer": { @@ -13146,10 +13226,9 @@ "description": "Specifies how to transform binary data into structured data.", "properties": { "avro_options": { - "description": "[Private Preview]", + "description": "[Beta]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AvroTransformerOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" }, "format": { @@ -13179,10 +13258,9 @@ "x-since-version": "v1.13.0" }, "protobuf_options": { - "description": "[Private Preview]", + "description": "[Beta]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ProtobufTransformerOptions", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.18.0" } }, @@ -13199,8 +13277,8 @@ "enumDescriptions": [ "[Beta]", "[Beta]", - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]" ] }, "pipelines.ZendeskSupportOptions": { @@ -13221,10 +13299,9 @@ "description": "Take a snapshot once per day, at the configured hour.", "properties": { "hour": { - "description": "[Private Preview] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", + "description": "[Beta] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" } }, @@ -13243,13 +13320,13 @@ "SUNDAY" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]", + "[Beta]" ] }, "postgres.EndpointGroupSpec": { @@ -13306,17 +13383,15 @@ "description": "Take a snapshot once per month, on the configured day at the configured hour.", "properties": { "day": { - "description": "[Private Preview] The day of the month on which to take the snapshot, in [1, 31]. In shorter\nmonths the snapshot is taken on the last day instead (day 31 runs on Feb 28\nor 29, and on Apr 30), so every month gets exactly one snapshot.", + "description": "[Beta] The day of the month on which to take the snapshot, in [1, 31]. In shorter\nmonths the snapshot is taken on the last day instead (day 31 runs on Feb 28\nor 29, and on Apr 30), so every month gets exactly one snapshot.", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" }, "hour": { - "description": "[Private Preview] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", + "description": "[Beta] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" } }, @@ -13478,31 +13553,27 @@ "description": "One cadence at which automatic snapshots are taken.", "properties": { "daily_schedule": { - "description": "[Private Preview] Take a snapshot once per day.", + "description": "[Beta] Take a snapshot once per day.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.DailySchedule", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" }, "monthly_schedule": { - "description": "[Private Preview] Take a snapshot once per month.", + "description": "[Beta] Take a snapshot once per month.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.MonthlySchedule", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" }, "retention": { - "description": "[Private Preview] How long snapshots from this cadence are kept before automatic deletion.\nMust be at least 1 hour. Applied when a snapshot is taken; not retroactive,\nso changing it affects only later snapshots.", + "description": "[Beta] How long snapshots from this cadence are kept before automatic deletion.\nMust be at least 1 hour. Applied when a snapshot is taken; not retroactive,\nso changing it affects only later snapshots.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" }, "weekly_schedule": { - "description": "[Private Preview] Take a snapshot once per week.", + "description": "[Beta] Take a snapshot once per week.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.WeeklySchedule", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" } }, @@ -13612,17 +13683,15 @@ "description": "Take a snapshot once per week, on the configured day at the configured hour.", "properties": { "day_of_week": { - "description": "[Private Preview] The day of the week on which to take the snapshot.", + "description": "[Beta] The day of the week on which to take the snapshot.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.DayOfWeek", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" }, "hour": { - "description": "[Private Preview] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", + "description": "[Beta] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.16.0" } }, @@ -15187,7 +15256,7 @@ }, "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+-------+--------------------------------------+--------------------------------+", + "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- AWS, COST_OPTIMIZED: On Demand Driver with Spot Executors.\n- AWS, RELIABILITY_OPTIMIZED: On Demand Driver and Executors.\n- AZURE, COST_OPTIMIZED: On Demand Driver and Executors.\n- AZURE, RELIABILITY_OPTIMIZED: On Demand Driver and Executors.", "enum": [ "POLICY_UNSPECIFIED", "COST_OPTIMIZED", @@ -15925,6 +15994,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironment" } }, + "jobs.JobEnvironmentVariables": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironmentVariables" + } + }, "jobs.JobParameterDefinition": { "type": "array", "items": { From e7b4d8cffcd07adac51ab896b47e1818b85f6af1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 14 Oct 2026 14:32:51 +0000 Subject: [PATCH 26/31] Update jsonschema_for_docs.json for v1.21.0 --- bundle/schema/jsonschema_for_docs.json | 161 ++++++++++++++++++++----- 1 file changed, 134 insertions(+), 27 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 732253e7563..9e69faaf6c4 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -35,6 +35,13 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, + "custom_template_format": { + "description": "[Private Preview] The format used to interpret the `custom_summary` and `custom_description` templates.\n\n`HTML` treats both templates as HTML with Mustache `{{VARIABLE_NAME}}` placeholders.\n`MARKDOWN` treats them as Markdown with allowlisted `@VARIABLE_NAME` placeholders and converts\nthem to the format each notification destination expects, so a single template renders\ncorrectly in email, Slack, and Microsoft Teams.\n\nWhen unset, the API applies no default. Responses omit the field unless a format is stored,\nand a template with no format is rendered as HTML.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CustomTemplateFormat", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.21.0" + }, "display_name": { "description": "The display name of the alert.", "$ref": "#/$defs/string", @@ -1998,7 +2005,7 @@ "x-since-version": "v0.229.0" }, "clusters": { - "description": "Cluster settings for this pipeline deployment.", + "description": "Cluster settings for this pipeline deployment. Applies to classic\n(non-serverless) pipelines. Omit this field when `serverless` is `true`.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster", "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" @@ -2097,6 +2104,13 @@ "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.2.0" }, + "parent_path": { + "description": "[Private Preview] Path of the pipeline parent folder in workspace file tree.\n\nIf absent, the pipeline doesn't have a workspace object.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.21.0" + }, "permissions": { "description": "The permissions to apply to this resource.", "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.PipelinePermission", @@ -2135,7 +2149,7 @@ "x-since-version": "v0.230.0" }, "serverless": { - "description": "Whether serverless compute is enabled for this pipeline.", + "description": "Whether serverless compute is enabled for this pipeline. Serverless is the\nrecommended compute for new pipelines; set this to `true` to run the pipeline\non serverless. For notebook/file pipelines, omitting this field uses classic\ncompute configured through the `clusters` field. When `true`, omit `clusters`;\nPhoton is always enabled.", "$ref": "#/$defs/bool", "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" @@ -3207,6 +3221,12 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.260.0" }, + "statement_timeout": { + "description": "[Beta] Warehouse statement timeout in seconds.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.21.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", @@ -4406,6 +4426,13 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.283.0" }, + "health_check": { + "description": "[Private Preview] Deploy-time health check for the app. Verifies the app is responding to HTTP requests before considering the deployment successful.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppHealthCheck", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.21.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", @@ -4453,6 +4480,27 @@ "type": "object", "additionalProperties": false }, + "apps.AppHealthCheck": { + "type": "object", + "description": "Deploy-time HTTP health check configuration for an app deployment.", + "properties": { + "path": { + "description": "[Private Preview] HTTP path to probe, e.g. \"/health\" or \"/api/status\".", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.21.0" + }, + "timeout": { + "description": "[Private Preview] Timeout to wait for the health check to pass before failing the deployment. If not set, a default timeout is used.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.21.0" + } + }, + "additionalProperties": false + }, "apps.AppPermissionLevel": { "type": "string", "description": "Permission level", @@ -4848,7 +4896,8 @@ "VOLUME", "TABLE", "FUNCTION", - "CONNECTION" + "CONNECTION", + "MODEL_SERVICE" ] }, "apps.ApplicationState": { @@ -5258,6 +5307,13 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" }, + "bedrock_mantle": { + "description": "[Private Preview] Amazon Bedrock provider configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAmazonBedrockProviderConfig", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.21.0" + }, "custom": { "description": "Custom OpenAI-compatible provider configuration with bearer-token\nauthentication.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigCustomProviderConfig", @@ -5306,6 +5362,13 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" }, + "pricing": { + "description": "[Private Preview] Pricing configuration for this provider service. An explicitly empty\nconfiguration is retained on Create and Update and applies no adjustment.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderPricingConfig", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.21.0" + }, "provider_type": { "description": "External model provider. Required on Create and immutable thereafter. Set\nthe matching provider-specific configuration, such as `openai`,\n`azure_openai`, or `amazon_bedrock`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigExternalModelProviderType", @@ -5557,7 +5620,18 @@ "EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK", "EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM", "EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY", - "EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE" + "EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE", + "EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "[Private Preview]" ] }, "catalog.ModelProviderServiceConfigGeminiEnterpriseProviderConfig": { @@ -5650,8 +5724,15 @@ }, "catalog.ModelProviderServiceConfigModelTargetConfig": { "type": "object", - "description": "Model target configuration for an external model destination.", + "description": "Model target configuration shared by model provider service targets and\nexternal model destinations on model services.", "properties": { + "endpoint_route": { + "description": "[Private Preview] Relative path appended to a custom provider's `base_url` for this model,\nsuch as `serve/openai/chat`. Only custom model provider service targets\nuse this field; other provider types ignore it, and model service\ndestinations reject it. Do not include URI templates, queries, or\nfragments. When empty, `base_url` is used unchanged.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.21.0" + }, "model": { "description": "Provider-side model identifier, such as `gpt-5` or `claude-opus-4-7`.\nThis identifies a model at the upstream provider; it is not a Unity\nCatalog model resource.", "$ref": "#/$defs/string", @@ -5659,7 +5740,7 @@ "x-since-version": "v1.17.0" }, "native_api_types": { - "description": "Provider-native API types supported by this model, such as\n`openai/v1/chat/completions`. At least one value is required. AI Gateway\nuses these values to translate requests and responses. At most 64 entries\nof 256 characters each are allowed.", + "description": "Provider-native API types supported by this model, such as\n`openai/v1/chat/completions`. A model provider service target requires at\nleast one value. A model service destination may omit the list to use the\nmatching provider service target's types when available. AI Gateway uses\nthe selected types for translation. At most 64 entries of 256 characters\neach are allowed.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" @@ -5708,6 +5789,20 @@ }, "additionalProperties": false }, + "catalog.ModelProviderServiceConfigProviderPricingConfig": { + "type": "object", + "description": "Pricing adjustments applied to this provider service's external-model spend\nestimates.", + "properties": { + "default_discount_basis_points": { + "description": "[Private Preview] Provider-wide adjustment to external-model spend estimates in basis points:\n2000 = 20% off; -2000 = a 20% markup. Negative values have no lower bound\nbeyond the int32 range. Values cannot exceed 10000 (100% off). An omitted\nvalue or zero leaves the estimate unchanged.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.21.0" + } + }, + "additionalProperties": false + }, "catalog.ModelProviderServiceConfigProviderSecret": { "type": "object", "description": "A secret value supplied as part of an inline provider config. The caller\nsupplies the value as inline `plaintext` on writes; the platform stores it\nencrypted. The `plaintext` field is `INPUT_ONLY` and never round-trips on\nreads.", @@ -9349,27 +9444,27 @@ "x-since-version": "v0.229.0" }, "full_refresh_selection": { - "description": "[Beta] A list of tables to update with fullRefresh.", + "description": "A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "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.", + "description": "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-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "refresh_selection": { - "description": "[Beta] A list of tables to update without fullRefresh.", + "description": "A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "reset_checkpoint_selection": { - "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", + "description": "A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" } }, @@ -9385,9 +9480,9 @@ "x-since-version": "v0.229.0" }, "full_refresh_selection": { - "description": "[Beta] A list of tables to update with fullRefresh.", + "description": "A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "parameters": { @@ -9403,21 +9498,21 @@ "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.", + "description": "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-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "refresh_selection": { - "description": "[Beta] A list of tables to update without fullRefresh.", + "description": "A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" }, "reset_checkpoint_selection": { - "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", + "description": "A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.1.0" } }, @@ -10961,9 +11056,9 @@ "x-since-version": "v0.298.0" }, "smartsheet_options": { - "description": "[Beta] Smartsheet specific options for ingestion", + "description": "[Public Preview] Smartsheet specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" }, "tiktok_ads_options": { @@ -11691,7 +11786,7 @@ "[Beta]", "[Beta]", "[Public Preview]", - "[Beta]", + "[Public Preview]", "[Beta]", "[Private Preview]" ] @@ -12860,9 +12955,9 @@ "description": "Smartsheet specific options for ingestion", "properties": { "enforce_schema": { - "description": "[Beta] (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.", + "description": "[Public 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": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" } }, @@ -15220,6 +15315,18 @@ "timezone_id" ] }, + "sql.CustomTemplateFormat": { + "type": "string", + "description": "Rendering format for the `custom_summary` and `custom_description` templates.", + "enum": [ + "HTML", + "MARKDOWN" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" + ] + }, "sql.EndpointTagPair": { "type": "object", "properties": { From 257fb2d7ac50512ad1dea8af6e6a2629ec2dfb7a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 22 Oct 2026 09:05:57 +0000 Subject: [PATCH 27/31] Update jsonschema_for_docs.json for v1.22.0 --- bundle/schema/jsonschema_for_docs.json | 1605 ++++++++++++++++++++++-- 1 file changed, 1524 insertions(+), 81 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 9e69faaf6c4..fda72df7b62 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -462,7 +462,7 @@ "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.", + "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" @@ -1018,6 +1018,91 @@ "url" ] }, + "resources.Feature": { + "type": "object", + "properties": { + "description": { + "description": "The description of the feature.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "entities": { + "description": "The entity columns for the feature, used as aggregation keys and for query-time lookup.\nOptional since entities are not set for RequestSource features or on-demand calculated features.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.EntityColumn", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "filter_condition": { + "description": "[Private Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + }, + "full_name": { + "description": "The full three-part name (catalog, schema, name) of the feature.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "function": { + "description": "The function by which the feature is computed.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.Function", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "inputs": { + "description": "[Private Preview]", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + }, + "lifecycle": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.22.0" + }, + "lineage_context": { + "description": "[Private Preview] Lineage context information for this feature.\nWARNING: This field is primarily intended for internal use by Databricks systems and\nis automatically populated when features are created through Databricks notebooks or jobs.\nUsers should not manually set this field as incorrect values may lead to inaccurate lineage tracking or unexpected behavior.\nThis field will be set by feature-engineering client and should be left unset by SDK and terraform users.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.LineageContext", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "source": { + "description": "The data source of the feature.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.DataSource", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "time_window": { + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.TimeWindow", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + }, + "timeseries_column": { + "description": "Column recording time, used for point-in-time joins, backfills, and aggregations.\nOptional since a timeseries column is not set for RequestSource features or on-demand\ncalculated features.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.TimeseriesColumn", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "full_name", + "function", + "source" + ] + }, "resources.GenieSpace": { "type": "object", "properties": { @@ -1237,6 +1322,13 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, + "duration_target": { + "description": "[Private Preview] The window the run aims to finish within, in hours, for a Cost-optimized serverless run.\nRequired only when `performance_target` is `COST_OPTIMIZED`. Must be one of the\nsupported values: `NO_FLEXIBILITY`, `4h`, `12h`, `24h`, `72h`. `NO_FLEXIBILITY` means the run\nuses the default cost-optimized performance level without additional cost-saving optimizations.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.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", @@ -1427,6 +1519,13 @@ "x-since-version": "v1.7.0", "deprecated": true }, + "duration_target": { + "description": "[Private Preview] The window the run aims to finish within, in hours, for a Cost-optimized serverless run.\nRequired only when `performance_target` is `COST_OPTIMIZED`. Must be one of the\nsupported values: `NO_FLEXIBILITY`, `4h`, `12h`, `24h`, `72h`. `NO_FLEXIBILITY` means the run\nuses the default cost-optimized performance level without additional cost-saving optimizations.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, "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", @@ -4011,6 +4110,12 @@ "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.ExternalLocation", "x-since-version": "v0.289.0" }, + "features": { + "description": "The feature definitions for the bundle, where each key is the name of the feature.", + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.Feature", + "markdownDescription": "The feature definitions for the bundle, where each key is the name of the feature.", + "x-since-version": "v1.22.0" + }, "genie_spaces": { "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.GenieSpace", "x-since-version": "v1.3.0" @@ -5308,10 +5413,9 @@ "x-since-version": "v1.17.0" }, "bedrock_mantle": { - "description": "[Private Preview] Amazon Bedrock provider configuration.", + "description": "Amazon Bedrock provider configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigAmazonBedrockProviderConfig", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.21.0" }, "custom": { @@ -5333,7 +5437,7 @@ "x-since-version": "v1.17.0" }, "forward_unmanaged_paths": { - "description": "Whether to proxy paths that AI Gateway does not recognize as configured\nprovider-native API types. Defaults to false. When true, these paths are\nforwarded unchanged to the upstream provider. When false, only\nrecognized API paths are served. Enabling this broadens the upstream API\nsurface exposed through the provider service.", + "description": "Whether to proxy paths that AI Gateway does not recognize as configured\nprovider-native API types. Defaults to false. When true, these paths are\nforwarded unchanged to the upstream provider. When false, only\nrecognized API paths are served. Enabling this broadens the upstream API\nsurface exposed through the provider service. AI Gateway cannot evaluate\nService Policies on opaque unmanaged requests, so unmanaged requests are\nrejected whenever Service Policies are attached to this securable.", "$ref": "#/$defs/bool", "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" @@ -5363,10 +5467,9 @@ "x-since-version": "v1.17.0" }, "pricing": { - "description": "[Private Preview] Pricing configuration for this provider service. An explicitly empty\nconfiguration is retained on Create and Update and applies no adjustment.", + "description": "Pricing configuration for this provider service. An explicitly empty\nconfiguration is retained on Create and Update and applies no adjustment.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigProviderPricingConfig", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.21.0" }, "provider_type": { @@ -5622,16 +5725,6 @@ "EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY", "EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE", "EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE" - ], - "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "[Private Preview]" ] }, "catalog.ModelProviderServiceConfigGeminiEnterpriseProviderConfig": { @@ -5727,10 +5820,9 @@ "description": "Model target configuration shared by model provider service targets and\nexternal model destinations on model services.", "properties": { "endpoint_route": { - "description": "[Private Preview] Relative path appended to a custom provider's `base_url` for this model,\nsuch as `serve/openai/chat`. Only custom model provider service targets\nuse this field; other provider types ignore it, and model service\ndestinations reject it. Do not include URI templates, queries, or\nfragments. When empty, `base_url` is used unchanged.", + "description": "Relative path appended to a custom provider's `base_url` for this model,\nsuch as `serve/openai/chat`. Nonempty values are only supported for\ncustom model provider service targets; other provider types reject them.\nModel service destinations do not support this field. Do not include\nURI templates, queries, or fragments. When empty, `base_url` is used unchanged.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.21.0" }, "model": { @@ -5794,10 +5886,9 @@ "description": "Pricing adjustments applied to this provider service's external-model spend\nestimates.", "properties": { "default_discount_basis_points": { - "description": "[Private Preview] Provider-wide adjustment to external-model spend estimates in basis points:\n2000 = 20% off; -2000 = a 20% markup. Negative values have no lower bound\nbeyond the int32 range. Values cannot exceed 10000 (100% off). An omitted\nvalue or zero leaves the estimate unchanged.", + "description": "Provider-wide adjustment to external-model spend estimates in basis points:\n2000 = 20% off; -2000 = a 20% markup. Negative values have no lower bound\nbeyond the int32 range. Values cannot exceed 10000 (100% off). An omitted\nvalue or zero leaves the estimate unchanged.", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "GA", "x-since-version": "v1.21.0" } }, @@ -6810,7 +6901,7 @@ "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.", + "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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" @@ -10137,6 +10228,13 @@ "jobs.Subscription": { "type": "object", "properties": { + "attachment": { + "description": "[Private Preview] Optional: The configuration for the files attached to the dashboard snapshot notification. It\ncontrols the underlying data of dashboard widgets that is attached as data files and which\npages are included in the attached PDF. If not specified, the notification is sent with only\nthe default snapshot.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachment", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, "custom_subject": { "description": "Optional: Allows users to specify a custom subject line on the email sent\nto subscribers.", "$ref": "#/$defs/string", @@ -10158,6 +10256,131 @@ }, "additionalProperties": false }, + "jobs.SubscriptionAttachment": { + "type": "object", + "description": "The configuration for the files attached to the dashboard snapshot notification sent to\nsubscribers. `data_attachment` describes the underlying data of dashboard widgets attached\nas data files, and `page_attachment` describes which dashboard pages are included in the\nattached PDF.", + "properties": { + "data_attachment": { + "description": "[Private Preview] Optional: The configuration for the underlying data of dashboard widgets attached as tabular\ndata files. If not specified, no tabular data is attached.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachment", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "page_attachment": { + "description": "[Private Preview] Optional: The selection of dashboard pages included in the attached PDF. If not specified,\nonly the first page is included.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentPageAttachment", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "jobs.SubscriptionAttachmentDataAttachment": { + "type": "object", + "description": "The configuration for the tabular data files attached to the dashboard snapshot. `widgets`\nlists the widgets whose data is exported and `file_format` is the output format; each\nreferenced widget's data is exported as a separate file.", + "properties": { + "file_format": { + "description": "[Private Preview] The file format of the exported tabular data files.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachmentFileFormat", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "include_applied_filters": { + "description": "[Private Preview] When true, the dashboard's applied filter values are included alongside the tabular data as\nan additional attached file.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "widgets": { + "description": "[Private Preview] The widgets whose underlying data is exported. At least one widget must be referenced.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachmentWidget", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "file_format", + "widgets" + ] + }, + "jobs.SubscriptionAttachmentDataAttachmentFileFormat": { + "type": "string", + "description": "The output format of an exported tabular data file. Must be set to a value other than\n`FILE_FORMAT_UNSPECIFIED`.", + "enum": [ + "FILE_FORMAT_CSV", + "FILE_FORMAT_TSV", + "FILE_FORMAT_EXCEL" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, + "jobs.SubscriptionAttachmentDataAttachmentWidget": { + "type": "object", + "description": "Identifies a dashboard widget whose data to attach. `page_id` and `widget_id` are\nthe URL identifiers from the dashboard's serialized definition returned by the Get dashboard\nAPI (`serialized_dashboard`), and together they uniquely identify the widget.", + "properties": { + "page_id": { + "description": "[Private Preview] The URL identifier of the page containing the widget. This is the value of the `name`\nfield of the corresponding entry under `pages` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "widget_id": { + "description": "[Private Preview] The URL identifier of the widget. This is the value of the `name` field of the\ncorresponding widget under that page's `layout` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "page_id", + "widget_id" + ] + }, + "jobs.SubscriptionAttachmentPageAttachment": { + "type": "object", + "description": "The selection of dashboard pages included in the attached PDF. `page_selection` chooses\nbetween all pages, the first page only, or an explicit subset listed in `page_ids`.", + "properties": { + "page_ids": { + "description": "[Private Preview] The identifiers of the pages to include in the PDF. Only specified when `page_selection` is\n`PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's\nserialized definition returned by the Get dashboard API (`serialized_dashboard`): the value\nof the `name` field of an entry under `pages`.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "page_selection": { + "description": "[Private Preview] How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to\ninclude are listed in `page_ids`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentPageAttachmentPageSelection", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "jobs.SubscriptionAttachmentPageAttachmentPageSelection": { + "type": "string", + "description": "Determines which dashboard pages are attached to the notification.", + "enum": [ + "PAGE_SELECTION_ALL", + "PAGE_SELECTION_SUBSET" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" + ] + }, "jobs.SubscriptionSubscriber": { "type": "object", "properties": { @@ -10743,84 +10966,1216 @@ }, "additionalProperties": false }, - "ml.ExperimentPermissionLevel": { - "type": "string", - "description": "Permission level", - "enum": [ - "CAN_MANAGE", - "CAN_EDIT", - "CAN_READ" - ] - }, - "ml.ExperimentTag": { + "ml.AggregationFunction": { "type": "object", - "description": "A tag for an experiment.", + "description": "An aggregation function applied over a time window.", "properties": { - "key": { - "description": "The tag key.", - "$ref": "#/$defs/string", + "approx_count_distinct": { + "description": "Computes the approximate count of distinct values.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ApproxCountDistinctFunction", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.229.0" + "x-since-version": "v1.22.0" }, - "value": { - "description": "The tag value.", - "$ref": "#/$defs/string", + "approx_percentile": { + "description": "Computes the approximate percentile of values.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ApproxPercentileFunction", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.229.0" - } - }, - "additionalProperties": false - }, - "ml.ExperimentTraceLocation": { - "type": "object", - "description": "The storage location for an experiment's traces.", - "properties": { - "uc_trace_location": { - "description": "[Private Preview] A Unity Catalog schema where the experiment's traces are stored as\nDelta tables.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.UcTraceLocation", + "x-since-version": "v1.22.0" + }, + "avg": { + "description": "Computes the average of values.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.AvgFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "count_function": { + "description": "Computes the count of values.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.CountFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "first": { + "description": "Returns the first value.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.FirstFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "first_distinct": { + "description": "[Private Preview] Returns the first N distinct values, ordered by the feature's timeseries column.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.FirstDistinctFunction", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, - "x-since-version": "v1.9.0" + "x-since-version": "v1.22.0" + }, + "first_n": { + "description": "[Private Preview] Returns the first N values, ordered by the feature's timeseries column.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.FirstNFunction", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "last": { + "description": "Returns the last value.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.LastFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "last_distinct": { + "description": "[Private Preview] Returns the last N distinct values, ordered by the feature's timeseries column.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.LastDistinctFunction", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "last_n": { + "description": "[Private Preview] Returns the last N values, ordered by the feature's timeseries column.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.LastNFunction", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "max": { + "description": "Computes the maximum value.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.MaxFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "min": { + "description": "Computes the minimum value.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.MinFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "stddev_pop": { + "description": "Computes the population standard deviation.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.StddevPopFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "stddev_samp": { + "description": "Computes the sample standard deviation.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.StddevSampFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "sum": { + "description": "Computes the sum of values.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.SumFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "time_window": { + "description": "The time window over which the aggregation is computed.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.TimeWindow", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "var_pop": { + "description": "Computes the population variance.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.VarPopFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "var_samp": { + "description": "Computes the sample variance.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.VarSampFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" } }, "additionalProperties": false }, - "ml.ModelTag": { + "ml.ApproxCountDistinctFunction": { "type": "object", - "description": "Tag for a registered model", + "description": "Computes the approximate count of distinct values.", "properties": { - "key": { - "description": "The tag key.", + "input": { + "description": "The input column from which the approximate count of distinct values is computed.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.229.0" + "x-since-version": "v1.22.0" }, - "value": { - "description": "The tag value.", - "$ref": "#/$defs/string", + "relative_sd": { + "description": "The maximum relative standard deviation allowed (default defined by Spark).", + "$ref": "#/$defs/float64", "x-databricks-launch-stage": "GA", - "x-since-version": "v0.229.0" + "x-since-version": "v1.22.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" + "additionalProperties": false, + "required": [ + "input" ] }, - "ml.UcTraceLocation": { + "ml.ApproxPercentileFunction": { "type": "object", - "description": "A Unity Catalog trace storage location. Traces are stored as Delta tables\nin the specified catalog and schema.", + "description": "Computes the approximate percentile of values.", "properties": { - "catalog": { - "description": "[Private Preview] The name of the Unity Catalog catalog.", + "accuracy": { + "description": "The accuracy parameter (higher is more accurate but slower).", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "input": { + "description": "The input column from which the approximate percentile is computed.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "percentile": { + "description": "The percentile value to compute (between 0 and 1).", + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input", + "percentile" + ] + }, + "ml.AvgFunction": { + "type": "object", + "description": "Computes the average of values.", + "properties": { + "input": { + "description": "The input column from which the average is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nColon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.ColumnIdentifier": { + "type": "object", + "properties": { + "variant_expr_path": { + "description": "[Private Preview] String representation of the column name using dot-prefixed path notation.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "variant_expr_path" + ] + }, + "ml.ColumnSelection": { + "type": "object", + "description": "A ColumnSelection function, equivalent to the LAST() record of an entity over a lifetime window", + "properties": { + "column": { + "description": "Column name from source to select as the feature value.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "column" + ] + }, + "ml.ContinuousWindow": { + "type": "object", + "properties": { + "offset": { + "description": "[Private Preview] The offset of the continuous window (must be non-positive).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "window_duration": { + "description": "[Private Preview] The duration of the continuous window (must be positive).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "window_duration" + ] + }, + "ml.CountFunction": { + "type": "object", + "description": "Computes the count of values.", + "properties": { + "input": { + "description": "The input column from which the count is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nColon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.CustomUdf": { + "type": "object", + "description": "A CustomUdf function applies a registered Unity Catalog function row-wise to\nsource columns, producing a single output column per row.", + "properties": { + "function_path": { + "description": "[Private Preview] Fully qualified 3-part Unity Catalog path of the function to apply.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "input_bindings": { + "description": "[Private Preview] Binds each UC function parameter to a source column.\nMay be empty for zero-argument functions (e.g. a timestamp generator).", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.InputBinding", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "function_path" + ] + }, + "ml.DataSource": { + "type": "object", + "description": "Specifies the data source backing a feature. Exactly one source type must be set.", + "properties": { + "delta_table_source": { + "description": "A Delta table data source.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.DeltaTableSource", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "feature_view_source": { + "description": "[Private Preview] A data source composed from registered upstream Features.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.FeatureViewSource", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "kafka_source": { + "description": "A Kafka stream data source.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.KafkaSource", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "lateness": { + "description": "[Private Preview] Completeness timing for this Feature's use of the source. This configuration is part of the\nFeature definition; it does not modify the underlying table or stream.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.SourceLateness", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "request_source": { + "description": "A request-time data source.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.RequestSource", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "stream_source": { + "description": "A Stream data source.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.StreamSource", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "ml.DeltaTableSource": { + "type": "object", + "properties": { + "dataframe_schema": { + "description": "Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if transformation_sql is specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\"col_a\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\"col_c\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "entity_columns": { + "description": "[Private Preview]", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + }, + "filter_condition": { + "description": "Single WHERE clause to filter delta table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "full_name": { + "description": "The full three-part (catalog, schema, table) name of the Delta table.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "timeseries_column": { + "description": "[Private Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + }, + "transformation_sql": { + "description": "A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *, col_a + col_b AS col_c FROM x.y.z WHERE col_a \u003e 0\" would have `transformation_sql` \"*, col_a + col_b AS col_c\")\nIf transformation_sql is not provided, all columns of the delta table are present in the DataSource dataframe.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "full_name" + ] + }, + "ml.EntityColumn": { + "type": "object", + "properties": { + "name": { + "description": "The name of the entity column. For Kafka sources, use dot-prefixed path notation to reference\nfields within the key or value schema (e.g., \"value.user_id\", \"key.partition_key\"). For nested\nfields, the leaf node name (e.g., \"user_id\" from \"value.trip_details.user_id\") is what will\nbe present in materialized tables and expected to match at query time.\nColon-prefixed notation (e.g., \"value:user_id\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "name" + ] + }, + "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-databricks-launch-stage": "GA", + "x-since-version": "v0.229.0" + }, + "value": { + "description": "The tag value.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v0.229.0" + } + }, + "additionalProperties": false + }, + "ml.ExperimentTraceLocation": { + "type": "object", + "description": "The storage location for an experiment's traces.", + "properties": { + "uc_trace_location": { + "description": "[Private Preview] A Unity Catalog schema where the experiment's traces are stored as\nDelta tables.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.UcTraceLocation", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.9.0" + } + }, + "additionalProperties": false + }, + "ml.FeatureReference": { + "type": "object", + "description": "A reference to one registered upstream Feature. A message rather than a bare name so an\nupstream can later be pinned more precisely (e.g. by version) without a breaking type change.", + "properties": { + "feature": { + "description": "[Private Preview] The three-part full name of the upstream Feature.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "feature" + ] + }, + "ml.FeatureViewSource": { + "type": "object", + "description": "A data source composed from registered upstream Features.", + "properties": { + "feature_references": { + "description": "[Private Preview] The upstream Features this source reads. Must include at least one feature.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.FeatureReference", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "ml.FieldDefinition": { + "type": "object", + "description": "A single field definition within a FlatSchema, specifying the field name and its scalar data type.\nDoes not support nested or complex types (arrays, maps, structs).", + "properties": { + "data_type": { + "description": "The scalar data type of the field.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ScalarDataType", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "name": { + "description": "The name of the field.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "data_type", + "name" + ] + }, + "ml.FirstDistinctFunction": { + "type": "object", + "description": "Returns the first N distinct values, ordered by the feature's timeseries column.", + "properties": { + "input": { + "description": "[Private Preview] The input column from which the first N distinct values are returned.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "n": { + "description": "[Private Preview] The number of distinct values to return.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input", + "n" + ] + }, + "ml.FirstFunction": { + "type": "object", + "description": "Returns the first value.", + "properties": { + "input": { + "description": "The input column from which the first value is returned.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.FirstNFunction": { + "type": "object", + "description": "Returns the first N values, ordered by the feature's timeseries column.", + "properties": { + "input": { + "description": "[Private Preview] The input column from which the first N values are returned.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "n": { + "description": "[Private Preview] The number of values to return.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input", + "n" + ] + }, + "ml.FlatSchema": { + "type": "object", + "description": "A flat (non-nested) schema for request-time fields, defined as an ordered list of field definitions.\nThis schema only supports scalar types.", + "properties": { + "fields": { + "description": "The list of fields in this schema.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.FieldDefinition", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "fields" + ] + }, + "ml.Function": { + "type": "object", + "properties": { + "aggregation_function": { + "description": "An aggregation function applied over a time window.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.AggregationFunction", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "column_selection": { + "description": "Selects the latest value of a single column in a data source", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ColumnSelection", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "custom_udf": { + "description": "[Private Preview] Applies a registered Unity Catalog function row-wise to source columns.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.CustomUdf", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "extra_parameters": { + "description": "[Private Preview]", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.FunctionExtraParameter", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + }, + "function_type": { + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.FunctionFunctionType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + } + }, + "additionalProperties": false + }, + "ml.FunctionExtraParameter": { + "type": "object", + "properties": { + "key": { + "description": "[Private Preview] The name of the parameter.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "value": { + "description": "[Private Preview] The value of the parameter.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "key", + "value" + ] + }, + "ml.FunctionFunctionType": { + "type": "string", + "enum": [ + "FUNCTION_TYPE_UNSPECIFIED", + "AVG", + "COUNT", + "SUM", + "MIN", + "MAX", + "FIRST", + "LAST", + "APPROX_COUNT_DISTINCT", + "APPROX_PERCENTILE", + "STDDEV_POP", + "STDDEV_SAMP", + "VAR_POP", + "VAR_SAMP" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, + "ml.InputBinding": { + "type": "object", + "description": "Binds a single UC function parameter to a source column.", + "properties": { + "column": { + "description": "[Private Preview] Source column whose value is passed for this parameter at execution time.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "parameter": { + "description": "[Private Preview] Name of the UC function parameter.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "column", + "parameter" + ] + }, + "ml.JobContext": { + "type": "object", + "properties": { + "job_id": { + "description": "[Private Preview] The job ID where this API invoked.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "job_run_id": { + "description": "[Private Preview] The job run ID where this API was invoked.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "ml.KafkaSource": { + "type": "object", + "properties": { + "entity_column_identifiers": { + "description": "[Private Preview]", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ColumnIdentifier", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + }, + "filter_condition": { + "description": "The filter condition applied to the source data before aggregation.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "name": { + "description": "Name of the Kafka source, used to identify it. This is used to look up the corresponding KafkaConfig object. Can be distinct from topic name.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "timeseries_column_identifier": { + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ColumnIdentifier", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + } + }, + "additionalProperties": false, + "required": [ + "name" + ] + }, + "ml.LastDistinctFunction": { + "type": "object", + "description": "Returns the last N distinct values, ordered by the feature's timeseries column.", + "properties": { + "input": { + "description": "[Private Preview] The input column from which the last N distinct values are returned.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "n": { + "description": "[Private Preview] The number of distinct values to return.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input", + "n" + ] + }, + "ml.LastFunction": { + "type": "object", + "description": "Returns the last value.", + "properties": { + "input": { + "description": "The input column from which the last value is returned.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.LastNFunction": { + "type": "object", + "description": "Returns the last N values, ordered by the feature's timeseries column.", + "properties": { + "input": { + "description": "[Private Preview] The input column from which the last N values are returned.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "n": { + "description": "[Private Preview] The number of values to return.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input", + "n" + ] + }, + "ml.LineageContext": { + "type": "object", + "description": "Lineage context information for tracking where an API was invoked. This will allow us to track lineage, which currently uses caller entity information for use across the Lineage Client and Observability in Lumberjack.", + "properties": { + "job_context": { + "description": "[Private Preview] Job context information including job ID and run ID.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.JobContext", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "notebook_id": { + "description": "[Private Preview] The notebook ID where this API was invoked.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "ml.MaxFunction": { + "type": "object", + "description": "Computes the maximum value.", + "properties": { + "input": { + "description": "The input column from which the maximum is computed.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.MinFunction": { + "type": "object", + "description": "Computes the minimum value.", + "properties": { + "input": { + "description": "The input column from which the minimum is computed.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.ModelTag": { + "type": "object", + "description": "Tag for a registered model", + "properties": { + "key": { + "description": "The tag key.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v0.229.0" + }, + "value": { + "description": "The tag value.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "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" + ] + }, + "ml.RequestSource": { + "type": "object", + "description": "A request-time data source whose value is provided at inference time: offline batch scoring or online serving endpoint", + "properties": { + "dataframe_schema": { + "description": "[Private Preview] A schema containing scalar or nested fields, in Spark StructType JSON format\n(from df.schema.json()). This preserves field, array-element, and map-value nullability.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "flat_schema": { + "description": "A flat schema with scalar-typed fields only.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.FlatSchema", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "ml.RollingWindow": { + "type": "object", + "description": "A rolling time window with an optional non-negative delay.", + "properties": { + "delay": { + "description": "Non-negative analytic lag that evaluates the window this far in the past. Use this for timing\nvariations unrelated to source lateness, such as a 30-day count as of one week ago. If unset,\nthe analytic lag is zero. It composes with source.lateness when both are set.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "window_duration": { + "description": "The duration of the rolling window. Must be positive when set; absent means lifetime\n(aggregate over the entity's entire history).", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "ml.SawtoothWindow": { + "type": "object", + "description": "A sawtooth window served via the hybrid batch + streaming path. The batch pipeline maintains\ndaily partial aggregates for the bulk of the window while the streaming pipeline maintains the\nmost recent day(s), and serving merges them on read. Same field shape as RollingWindow, but a\ndistinct type so the control plane can explicitly identify hybrid (sawtooth) features rather\nthan inferring hybrid behavior from window_duration.", + "properties": { + "delay": { + "description": "[Private Preview] Delay is not currently supported for Sawtooth windows.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "window_duration": { + "description": "[Private Preview] The duration of the window. Must be positive and span more than two days when set, so that both\nthe batch (N-1 day) and stale-path (N-2 day) partial aggregates are well defined. The duration\nneed not be a whole number of days (e.g. 3 days 15 minutes is allowed). Absent means lifetime\n(aggregate over the entity's entire history).", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "ml.ScalarDataType": { + "type": "string", + "description": "Scalar data types for request-time field definitions.\nOnly flat (non-nested) types are supported.", + "enum": [ + "INTEGER", + "FLOAT", + "BOOLEAN", + "STRING", + "DOUBLE", + "LONG", + "TIMESTAMP", + "DATE", + "SHORT", + "BINARY", + "DECIMAL" + ] + }, + "ml.SlidingWindow": { + "type": "object", + "properties": { + "delay": { + "description": "[Private Preview] Non-negative analytic lag that evaluates the window this far in the past. Use this for timing\nvariations unrelated to source lateness, such as a 30-day count as of one week ago. If unset,\nthe analytic lag is zero. It composes with source.lateness when both are set.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "offset": { + "description": "[Private Preview] Non-negative phase shift from the default midnight UTC alignment. For example, offset=22h on\na 24h slide produces boundaries at 22:00 UTC (17:00 New York in standard time) instead of\nmidnight UTC. If unset, the offset is zero. Must be shorter than slide_duration (and therefore\nwindow_duration).", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "slide_duration": { + "description": "The slide duration (interval by which windows advance, must be positive and less than duration).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "window_duration": { + "description": "The duration of the sliding window. Must be positive when set; absent means lifetime\n(aggregate over the entity's entire history).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "slide_duration" + ] + }, + "ml.SourceLateness": { + "type": "object", + "description": "Configures when event-time data from this source is considered complete for a Feature.", + "properties": { + "settling_delay": { + "description": "[Private Preview] Non-negative time to wait after a window ends before treating its source data as complete.\nTraining shifts the eligible evaluation time backwards by this duration so it does not join\ndata that would still have been settling online. Materialization waits for the duration to\nelapse before publishing the window. If unset, source data is considered settled immediately.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "ml.StddevPopFunction": { + "type": "object", + "description": "Computes the population standard deviation.", + "properties": { + "input": { + "description": "The input column from which the population standard deviation is computed. For Kafka sources,\nuse dot-prefixed path notation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nColon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.StddevSampFunction": { + "type": "object", + "description": "Computes the sample standard deviation.", + "properties": { + "input": { + "description": "The input column from which the sample standard deviation is computed.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.StreamSource": { + "type": "object", + "description": "A Stream entity used as a data source for a feature.", + "properties": { + "dataframe_schema": { + "description": "[Private Preview] Schema of the resulting dataframe after transformations, in Spark StructType\nJSON format (from df.schema.json()).\nAny subsequent functions operate against this dataframe.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "filter_condition": { + "description": "The filter condition applied to the source data before aggregation.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "full_name": { + "description": "Three-part full name of the Stream (catalog.schema.stream).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "transformation_sql": { + "description": "[Private Preview] The pipeline runs these SQL statements immediately after conversion into\nthe schema specified on the Stream object.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "full_name" + ] + }, + "ml.SumFunction": { + "type": "object", + "description": "Computes the sum of values.", + "properties": { + "input": { + "description": "The input column from which the sum is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nColon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.TimeWindow": { + "type": "object", + "properties": { + "continuous": { + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ContinuousWindow", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.22.0", + "deprecated": true + }, + "rolling": { + "description": "A rolling time window with an optional non-negative delay.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.RollingWindow", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "sawtooth": { + "description": "[Private Preview] A sawtooth window served via the hybrid batch + streaming path.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.SawtoothWindow", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "sliding": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.SlidingWindow", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + }, + "start_time": { + "description": "[Private Preview] Earliest event-time boundary at which the Feature may emit an output. This gates outputs, not\nthe historical inputs read by a window. For example, a 365-day window with\nstart_time=2026-01-01 begins emitting partial-window values on that date instead of waiting\nfor 365 days of data; a lifetime window produces no output before start_time. If unset,\ntumbling and fixed-duration sliding windows first emit at an offset-aligned boundary after a\nfull window can be formed. If unset, lifetime sliding windows and rolling windows emit as soon as\neligible source data exists.\nNot currently supported for sawtooth windows or for Features with a stream source.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "tumbling": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.TumblingWindow", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false + }, + "ml.TimeseriesColumn": { + "type": "object", + "properties": { + "name": { + "description": "The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \"event_timestamp\" from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nColon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "name" + ] + }, + "ml.TumblingWindow": { + "type": "object", + "properties": { + "delay": { + "description": "[Private Preview] Non-negative analytic lag that evaluates the window this far in the past. Use this for timing\nvariations unrelated to source lateness, such as a 30-day count as of one week ago. If unset,\nthe analytic lag is zero. It composes with source.lateness when both are set.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "offset": { + "description": "[Private Preview] Non-negative phase shift from the default midnight UTC alignment. For example, offset=22h on\na 24h window produces boundaries at 22:00 UTC (17:00 New York in standard time) instead of\nmidnight UTC. If unset, the offset is zero. Must be shorter than window_duration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.22.0" + }, + "window_duration": { + "description": "The duration of each tumbling window (non-overlapping, fixed-duration windows).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "window_duration" + ] + }, + "ml.UcTraceLocation": { + "type": "object", + "description": "A Unity Catalog trace storage location. Traces are stored as Delta tables\nin the specified catalog and schema.", + "properties": { + "catalog": { + "description": "[Private Preview] The name of the Unity Catalog catalog.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -10847,6 +12202,38 @@ "schema" ] }, + "ml.VarPopFunction": { + "type": "object", + "description": "Computes the population variance.", + "properties": { + "input": { + "description": "The input column from which the population variance is computed.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.VarSampFunction": { + "type": "object", + "description": "Computes the sample variance.", + "properties": { + "input": { + "description": "The input column from which the sample variance is computed.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, "pipelines.ApiSourceConnectorConfig": { "type": "object", "description": "Top-level configuration for API Source connectors with arbitrary configuration.", @@ -11740,6 +13127,7 @@ }, "pipelines.IngestionSourceType": { "type": "string", + "description": "Type of source system that a managed ingestion pipeline reads from.", "enum": [ "MYSQL", "POSTGRESQL", @@ -15284,7 +16672,14 @@ "enum": [ "TYPE_UNSPECIFIED", "CLASSIC", - "PRO" + "PRO", + "REALTIME" + ], + "enumDescriptions": [ + "", + "", + "", + "[Private Preview]" ] }, "sql.CronSchedule": { @@ -15652,6 +17047,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ExternalLocation" } }, + "resources.Feature": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Feature" + } + }, "resources.GenieSpace": { "type": "object", "additionalProperties": { @@ -16137,6 +17538,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription" } }, + "jobs.SubscriptionAttachmentDataAttachmentWidget": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachmentWidget" + } + }, "jobs.SubscriptionSubscriber": { "type": "array", "items": { @@ -16167,12 +17574,48 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Webhook" } }, + "ml.ColumnIdentifier": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ColumnIdentifier" + } + }, + "ml.EntityColumn": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.EntityColumn" + } + }, "ml.ExperimentTag": { "type": "array", "items": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTag" } }, + "ml.FeatureReference": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.FeatureReference" + } + }, + "ml.FieldDefinition": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.FieldDefinition" + } + }, + "ml.FunctionExtraParameter": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.FunctionExtraParameter" + } + }, + "ml.InputBinding": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.InputBinding" + } + }, "ml.ModelTag": { "type": "array", "items": { From 4cd97eb15b407712f7457ef02aaafe8f61d1cfcb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 22 Oct 2026 13:19:41 +0000 Subject: [PATCH 28/31] Update jsonschema_for_docs.json for v1.22.1 --- bundle/schema/jsonschema_for_docs.json | 139 ++++++++++++++++++------- 1 file changed, 102 insertions(+), 37 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index fda72df7b62..f11e1026f9d 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -3290,6 +3290,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.LifecycleWithStarted", "x-since-version": "v0.268.0" }, + "max_dbu": { + "description": "[Private Preview] Maximum compute capacity of a real-time SQL warehouse, in DBU per hour.\nMust be a multiple of 3 between 3 and 960. The effective maximum cannot be\nlower than the warehouse's minimum capacity.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, "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", @@ -3314,6 +3320,12 @@ "markdownDescription": "A Sequence of permissions to apply to this resource, where each item grants a permission `level` to a single `user_name`, `group_name`, or `service_principal_name`. A principal cannot be set in both a resource's `permissions` and the top-level `permissions` mapping.\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.260.0" }, + "reyden_cluster_size_multiplier": { + "description": "[Private Preview] Cluster size multiplier for Reyden warehouses. Scales the effective compute\ncapacity relative to the nominal virtual cluster size. Only meaningful when\nthe warehouse is of Reyden type.\n\nAccepted range: 1.0 to the workspace-configured maximum (decimals\nallowed). The default maximum is 100.0.\n- Values below 1.0 are normalized to 1.0.\n- Values above the configured maximum are capped at that maximum.\n- When absent, the warehouse is treated as having a multiplier of 1.0.", + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, "spot_instance_policy": { "description": "Configurations whether the endpoint should use spot instances.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SpotInstancePolicy", @@ -5419,7 +5431,7 @@ "x-since-version": "v1.21.0" }, "custom": { - "description": "Custom OpenAI-compatible provider configuration with bearer-token\nauthentication.", + "description": "Custom OpenAI-compatible provider configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigCustomProviderConfig", "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" @@ -5652,7 +5664,7 @@ }, "catalog.ModelProviderServiceConfigCustomProviderConfig": { "type": "object", - "description": "Custom OpenAI-compatible provider configuration with bearer-token\nauthentication.", + "description": "Custom OpenAI-compatible provider configuration.", "properties": { "direct": { "description": "Endpoint and authentication configuration for the custom provider.", @@ -10229,10 +10241,9 @@ "type": "object", "properties": { "attachment": { - "description": "[Private Preview] Optional: The configuration for the files attached to the dashboard snapshot notification. It\ncontrols the underlying data of dashboard widgets that is attached as data files and which\npages are included in the attached PDF. If not specified, the notification is sent with only\nthe default snapshot.", + "description": "[Beta] Optional: The configuration for the files attached to the dashboard snapshot notification. It\ncontrols the underlying data of dashboard widgets that is attached as data files and which\npages are included in the attached PDF. If not specified, the notification is sent with only\nthe default snapshot.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachment", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" }, "custom_subject": { @@ -10261,17 +10272,15 @@ "description": "The configuration for the files attached to the dashboard snapshot notification sent to\nsubscribers. `data_attachment` describes the underlying data of dashboard widgets attached\nas data files, and `page_attachment` describes which dashboard pages are included in the\nattached PDF.", "properties": { "data_attachment": { - "description": "[Private Preview] Optional: The configuration for the underlying data of dashboard widgets attached as tabular\ndata files. If not specified, no tabular data is attached.", + "description": "[Beta] Optional: The configuration for the underlying data of dashboard widgets attached as tabular\ndata files. If not specified, no tabular data is attached.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachment", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" }, "page_attachment": { - "description": "[Private Preview] Optional: The selection of dashboard pages included in the attached PDF. If not specified,\nonly the first page is included.", + "description": "[Beta] Optional: The selection of dashboard pages included in the attached PDF. If not specified,\nonly the first page is included.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentPageAttachment", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" } }, @@ -10282,24 +10291,21 @@ "description": "The configuration for the tabular data files attached to the dashboard snapshot. `widgets`\nlists the widgets whose data is exported and `file_format` is the output format; each\nreferenced widget's data is exported as a separate file.", "properties": { "file_format": { - "description": "[Private Preview] The file format of the exported tabular data files.", + "description": "[Beta] The file format of the exported tabular data files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachmentFileFormat", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" }, "include_applied_filters": { - "description": "[Private Preview] When true, the dashboard's applied filter values are included alongside the tabular data as\nan additional attached file.", + "description": "[Beta] When true, the dashboard's applied filter values are included alongside the tabular data as\nan additional attached file.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" }, "widgets": { - "description": "[Private Preview] The widgets whose underlying data is exported. At least one widget must be referenced.", + "description": "[Beta] The widgets whose underlying data is exported. At least one widget must be referenced.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachmentWidget", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" } }, @@ -10318,9 +10324,9 @@ "FILE_FORMAT_EXCEL" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]", + "[Beta]" ] }, "jobs.SubscriptionAttachmentDataAttachmentWidget": { @@ -10328,17 +10334,15 @@ "description": "Identifies a dashboard widget whose data to attach. `page_id` and `widget_id` are\nthe URL identifiers from the dashboard's serialized definition returned by the Get dashboard\nAPI (`serialized_dashboard`), and together they uniquely identify the widget.", "properties": { "page_id": { - "description": "[Private Preview] The URL identifier of the page containing the widget. This is the value of the `name`\nfield of the corresponding entry under `pages` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "description": "[Beta] The URL identifier of the page containing the widget. This is the value of the `name`\nfield of the corresponding entry under `pages` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" }, "widget_id": { - "description": "[Private Preview] The URL identifier of the widget. This is the value of the `name` field of the\ncorresponding widget under that page's `layout` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "description": "[Beta] The URL identifier of the widget. This is the value of the `name` field of the\ncorresponding widget under that page's `layout` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" } }, @@ -10353,17 +10357,15 @@ "description": "The selection of dashboard pages included in the attached PDF. `page_selection` chooses\nbetween all pages, the first page only, or an explicit subset listed in `page_ids`.", "properties": { "page_ids": { - "description": "[Private Preview] The identifiers of the pages to include in the PDF. Only specified when `page_selection` is\n`PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's\nserialized definition returned by the Get dashboard API (`serialized_dashboard`): the value\nof the `name` field of an entry under `pages`.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "description": "[Beta] The identifiers of the pages to include in the PDF. Only specified when `page_selection` is\n`PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's\nserialized definition returned by the Get dashboard API (`serialized_dashboard`): the value\nof the `name` field of an entry under `pages`.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" }, "page_selection": { - "description": "[Private Preview] How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to\ninclude are listed in `page_ids`.", + "description": "[Beta] How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to\ninclude are listed in `page_ids`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentPageAttachmentPageSelection", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.22.0" } }, @@ -10377,8 +10379,8 @@ "PAGE_SELECTION_SUBSET" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]" ] }, "jobs.SubscriptionSubscriber": { @@ -11283,6 +11285,12 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v1.22.0" }, + "sdp_source": { + "description": "[Private Preview] A Spark Declarative Pipeline data source.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.SdpSource", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, "stream_source": { "description": "A Stream data source.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.StreamSource", @@ -11948,6 +11956,63 @@ "DECIMAL" ] }, + "ml.SdpSource": { + "type": "object", + "description": "A Spark Declarative Pipeline (SDP) data source.", + "properties": { + "dataframe_schema": { + "description": "[Private Preview] Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if transformation_sql is specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\"col_a\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\"col_c\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, + "filter_condition": { + "description": "[Private Preview] Single WHERE clause to filter the pipeline's output table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, + "input_tables": { + "description": "[Private Preview] The full three-part names of the tables the pipeline reads from. Required to materialize this\nfeature with a TableTrigger, which starts a run when these tables update. Each table must exist\nwhen the feature is created. After the pipeline runs, Feature Store checks that it reads from\nthese tables, and the run fails if it doesn't. At most 100 tables.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, + "output_table": { + "description": "[Private Preview] The full three-part (catalog, schema, table) name of the pipeline's output table to read from.\nThe table doesn't need to exist until the pipeline first runs. Required.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, + "pipeline_id": { + "description": "[Private Preview] The ID of the Spark Declarative Pipeline that Feature Store runs to produce this source, before\neach materialization or backfill. The pipeline must already exist when the feature is created,\nand you need CAN_RUN, CAN_MANAGE, or owner permission on it. It doesn't need to have run yet.\nDeleting the feature doesn't delete the pipeline. If the pipeline is deleted, this field reads\nback empty. Required.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, + "transformation_sql": { + "description": "[Private Preview] A single SQL SELECT expression applied after filter_condition.\nShould contain all the columns needed (eg. \"SELECT *, col_a + col_b AS col_c FROM x.y.z WHERE col_a \u003e 0\" would have `transformation_sql` \"*, col_a + col_b AS col_c\")\nIf transformation_sql is not provided, all columns of the pipeline's output table are present in the DataSource dataframe.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + } + }, + "additionalProperties": false + }, + "ml.SdpSourceState": { + "type": "string", + "description": "State of the SDP source relative to pipeline execution and output table validation.", + "enum": [ + "PENDING", + "RESOLVED", + "ERROR" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, "ml.SlidingWindow": { "type": "object", "properties": { From e2ee005f5b1bb9a4c9d804759f3c7aabd24f73c2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 29 Oct 2026 12:07:10 +0000 Subject: [PATCH 29/31] Update jsonschema_for_docs.json for v1.23.0 --- bundle/schema/jsonschema_for_docs.json | 221 +++++++++++++++++++------ 1 file changed, 169 insertions(+), 52 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index f11e1026f9d..86609947ccb 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -24,22 +24,21 @@ "type": "object", "properties": { "custom_description": { - "description": "Custom description for the alert. support mustache template.", + "description": "Custom description for the alert. Interpreted according to `custom_template_format`.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "custom_summary": { - "description": "Custom summary for the alert. support mustache template.", + "description": "Custom summary for the alert. Interpreted according to `custom_template_format`.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v0.279.0" }, "custom_template_format": { - "description": "[Private Preview] The format used to interpret the `custom_summary` and `custom_description` templates.\n\n`HTML` treats both templates as HTML with Mustache `{{VARIABLE_NAME}}` placeholders.\n`MARKDOWN` treats them as Markdown with allowlisted `@VARIABLE_NAME` placeholders and converts\nthem to the format each notification destination expects, so a single template renders\ncorrectly in email, Slack, and Microsoft Teams.\n\nWhen unset, the API applies no default. Responses omit the field unless a format is stored,\nand a template with no format is rendered as HTML.", + "description": "[Beta] The format used to interpret the `custom_summary` and `custom_description` templates.\n\n`HTML` treats both templates as HTML with Mustache `{{VARIABLE_NAME}}` placeholders.\n`MARKDOWN` treats them as Markdown with allowlisted `@VARIABLE_NAME` placeholders and converts\nthem to the format each notification destination expects, so a single template renders\ncorrectly in email, Slack, and Microsoft Teams.\n\nWhen unset, the API applies no default. Responses omit the field unless a format is stored,\nand a template with no format is rendered as HTML.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CustomTemplateFormat", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.21.0" }, "display_name": { @@ -206,10 +205,9 @@ "x-since-version": "v0.239.0" }, "space": { - "description": "[Private Preview] Name of the space this app belongs to.", + "description": "[Beta] Name of the space this app belongs to.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.290.0" }, "telemetry_export_destinations": { @@ -936,6 +934,20 @@ "name" ] }, + "resources.DependsOn": { + "type": "object", + "properties": { + "resource": { + "description": "Key of the resource to depend on, as `foo` or `jobs.foo`.", + "$ref": "#/$defs/string", + "x-since-version": "v1.23.0" + } + }, + "additionalProperties": false, + "required": [ + "resource" + ] + }, "resources.ExternalLocation": { "type": "object", "properties": { @@ -1630,6 +1642,11 @@ "resources.JobRunLifecycle": { "type": "object", "properties": { + "depends_on": { + "description": "Resources that must be deployed before this resource and deleted after it. Unlike variable references, this only affects ordering.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.DependsOn", + "x-since-version": "v1.23.0" + }, "prevent_destroy": { "description": "Lifecycle setting to prevent the resource from being destroyed.", "$ref": "#/$defs/bool", @@ -1662,6 +1679,11 @@ "resources.Lifecycle": { "type": "object", "properties": { + "depends_on": { + "description": "Resources that must be deployed before this resource and deleted after it. Unlike variable references, this only affects ordering.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.DependsOn", + "x-since-version": "v1.23.0" + }, "prevent_destroy": { "description": "Lifecycle setting to prevent the resource from being destroyed.", "$ref": "#/$defs/bool", @@ -1673,6 +1695,11 @@ "resources.LifecycleWithStarted": { "type": "object", "properties": { + "depends_on": { + "description": "Resources that must be deployed before this resource and deleted after it. Unlike variable references, this only affects ordering.", + "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.DependsOn", + "x-since-version": "v1.23.0" + }, "prevent_destroy": { "description": "Lifecycle setting to prevent the resource from being destroyed.", "$ref": "#/$defs/bool", @@ -3294,7 +3321,8 @@ "description": "[Private Preview] Maximum compute capacity of a real-time SQL warehouse, in DBU per hour.\nMust be a multiple of 3 between 3 and 960. The effective maximum cannot be\nlower than the warehouse's minimum capacity.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "doNotSuggest": true, + "x-since-version": "v1.23.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.", @@ -3324,7 +3352,8 @@ "description": "[Private Preview] Cluster size multiplier for Reyden warehouses. Scales the effective compute\ncapacity relative to the nominal virtual cluster size. Only meaningful when\nthe warehouse is of Reyden type.\n\nAccepted range: 1.0 to the workspace-configured maximum (decimals\nallowed). The default maximum is 100.0.\n- Values below 1.0 are normalized to 1.0.\n- Values above the configured maximum are capped at that maximum.\n- When absent, the warehouse is treated as having a multiplier of 1.0.", "$ref": "#/$defs/float64", "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "doNotSuggest": true, + "x-since-version": "v1.23.0" }, "spot_instance_policy": { "description": "Configurations whether the endpoint should use spot instances.", @@ -3919,7 +3948,9 @@ "immutable_folder": { "description": "Whether to deploy bundle files and artifacts as a single immutable snapshot. When true, all files are packaged into a content-addressed archive and workspace.file_path and workspace.artifact_path are set to the resulting location.", "$ref": "#/$defs/bool", - "x-since-version": "v1.6.0" + "deprecationMessage": "Deprecated: please set workspace.sync_mode to immutable instead", + "x-since-version": "v1.6.0", + "deprecated": true }, "pydabs": { "description": "The PyDABs configuration.", @@ -4024,7 +4055,9 @@ "source_linked_deployment": { "description": "Whether to link the deployment to the bundle source.", "$ref": "#/$defs/bool", - "x-since-version": "v0.236.0" + "deprecationMessage": "Deprecated: please set workspace.sync_mode to in-place instead", + "x-since-version": "v0.236.0", + "deprecated": true }, "tags": { "description": "The tags for the bundle deployment.", @@ -4315,6 +4348,19 @@ }, "additionalProperties": false }, + "config.SyncMode": { + "type": "string", + "enum": [ + "overwrite", + "in-place", + "immutable" + ], + "enumDescriptions": [ + "Upload bundle files to workspace.file_path, replacing the files of the previous deployment.", + "Do not upload bundle files. Deployed resources reference the source files in the workspace directly. Available only when deploying from the Databricks Workspace.", + "Upload bundle files and artifacts as a single immutable snapshot and set workspace.file_path and workspace.artifact_path to its location." + ] + }, "config.Target": { "type": "object", "properties": { @@ -4488,6 +4534,11 @@ "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, + "sync_mode": { + "description": "How bundle files are made available to deployed resources. Valid values are `overwrite`, `in-place`, and `immutable`. Defaults to `in-place` for development deployments from the Databricks Workspace and to `overwrite` otherwise.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config.SyncMode", + "x-since-version": "v1.23.0" + }, "workspace_id": { "description": "The Databricks workspace ID", "$ref": "#/$defs/string", @@ -7270,7 +7321,7 @@ "x-since-version": "v0.271.0" }, "project_environment": { - "description": "[Beta] File path of pyproject.toml file that defines the project-scoped environment.", + "description": "[Beta] Path to the `pyproject.toml` file that defines the project environment.\nThis field cannot be combined with `environment_version`, `base_environment`, dependency fields,\nor any other environment-source fields. Set the environment version and dependencies in `pyproject.toml` instead.\nFor more information, see the serverless dependencies documentation.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.20.0" @@ -11097,8 +11148,15 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v1.22.0" }, + "relative_error": { + "description": "[Private Preview] The error the user accepts, as a fraction of the count, between 0.02 (by default) and 0.3.\nThis is one standard error of the estimate, the same meaning as Spark's relativeSD: 0.02 means\nthe result is within ±2% of the true count about 68% of the time (one standard deviation covers\n68% of the region). Feature Store picks the sketch size that gives this relative error. If\nneither relative_error nor relative_sd is set, 0.02 is default chosen at feature creation.", + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.23.0" + }, "relative_sd": { - "description": "The maximum relative standard deviation allowed (default defined by Spark).", + "description": "The maximum relative standard deviation allowed (default defined by Spark).\nDeprecated: use relative_error. When relative_error is set, reads return the same value here\nfor clients that don't have relative_error, and a request may only send that value.", "$ref": "#/$defs/float64", "x-databricks-launch-stage": "GA", "x-since-version": "v1.22.0" @@ -11114,7 +11172,7 @@ "description": "Computes the approximate percentile of values.", "properties": { "accuracy": { - "description": "The accuracy parameter (higher is more accurate but slower).", + "description": "The accuracy parameter (higher is more accurate but slower).\nDeprecated: use relative_error. When relative_error is set, reads return ceil(1 /\nrelative_error) here for clients that don't have relative_error, and a request may only send\nthat value.", "$ref": "#/$defs/int64", "x-databricks-launch-stage": "GA", "x-since-version": "v1.22.0" @@ -11130,6 +11188,13 @@ "$ref": "#/$defs/float64", "x-databricks-launch-stage": "GA", "x-since-version": "v1.22.0" + }, + "relative_error": { + "description": "[Private Preview] The error the user accepts, as a fraction of rank, between 0.01 (by default) and 0.3. The\nresult is within this rank error with 99% confidence: at 0.01, the value returned for p95 is\nbetween the true p94 and p96 at least 99% of the time. Feature Store picks the sketch size that\ngives this error.\nIf neither relative_error nor accuracy is set, 0.01 is default chosen at feature creation.", + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.23.0" } }, "additionalProperties": false, @@ -11289,7 +11354,8 @@ "description": "[Private Preview] A Spark Declarative Pipeline data source.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.SdpSource", "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "doNotSuggest": true, + "x-since-version": "v1.23.0" }, "stream_source": { "description": "A Stream data source.", @@ -11964,37 +12030,43 @@ "description": "[Private Preview] Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if transformation_sql is specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\"col_a\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\"col_c\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "doNotSuggest": true, + "x-since-version": "v1.23.0" }, "filter_condition": { "description": "[Private Preview] Single WHERE clause to filter the pipeline's output table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "doNotSuggest": true, + "x-since-version": "v1.23.0" }, "input_tables": { - "description": "[Private Preview] The full three-part names of the tables the pipeline reads from. Required to materialize this\nfeature with a TableTrigger, which starts a run when these tables update. Each table must exist\nwhen the feature is created. After the pipeline runs, Feature Store checks that it reads from\nthese tables, and the run fails if it doesn't. At most 100 tables.", + "description": "[Private Preview] The full three-part names of the tables the pipeline reads from. Required to materialize this\nfeature with a TableTrigger, which starts a run when these tables update. Each table must exist\nwhen the feature is created. Feature Store doesn't confirm that the pipeline reads from these\ntables. At most 100 tables.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "doNotSuggest": true, + "x-since-version": "v1.23.0" }, "output_table": { "description": "[Private Preview] The full three-part (catalog, schema, table) name of the pipeline's output table to read from.\nThe table doesn't need to exist until the pipeline first runs. Required.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "doNotSuggest": true, + "x-since-version": "v1.23.0" }, "pipeline_id": { "description": "[Private Preview] The ID of the Spark Declarative Pipeline that Feature Store runs to produce this source, before\neach materialization or backfill. The pipeline must already exist when the feature is created,\nand you need CAN_RUN, CAN_MANAGE, or owner permission on it. It doesn't need to have run yet.\nDeleting the feature doesn't delete the pipeline. If the pipeline is deleted, this field reads\nback empty. Required.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "doNotSuggest": true, + "x-since-version": "v1.23.0" }, "transformation_sql": { "description": "[Private Preview] A single SQL SELECT expression applied after filter_condition.\nShould contain all the columns needed (eg. \"SELECT *, col_a + col_b AS col_c FROM x.y.z WHERE col_a \u003e 0\" would have `transformation_sql` \"*, col_a + col_b AS col_c\")\nIf transformation_sql is not provided, all columns of the pipeline's output table are present in the DataSource dataframe.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true + "doNotSuggest": true, + "x-since-version": "v1.23.0" } }, "additionalProperties": false @@ -12480,6 +12552,13 @@ "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, + "onedrive_options": { + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OneDriveOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.23.0" + }, "outlook_options": { "description": "[Private Preview] Outlook specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", @@ -13216,6 +13295,7 @@ "ZENDESK", "SMARTSHEET", "RABBITMQ", + "ONEDRIVE", "FOREIGN_CATALOG" ], "enumDescriptions": [ @@ -13241,6 +13321,7 @@ "[Public Preview]", "[Public Preview]", "[Beta]", + "[Private Preview]", "[Private Preview]" ] }, @@ -13624,6 +13705,45 @@ }, "additionalProperties": false }, + "pipelines.OneDriveOptions": { + "type": "object", + "properties": { + "entity_type": { + "description": "[Private Preview] (Optional) The type of OneDrive entity to ingest.\nIf not specified, defaults to FILE.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OneDriveOptionsOneDriveEntityType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.23.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": "v1.23.0" + }, + "url": { + "description": "[Private Preview] Required. The OneDrive URL.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.23.0" + } + }, + "additionalProperties": false + }, + "pipelines.OneDriveOptionsOneDriveEntityType": { + "type": "string", + "description": "The type of OneDrive entity to ingest.", + "enum": [ + "FILE", + "FILE_METADATA" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" + ] + }, "pipelines.OperationTimeWindow": { "type": "object", "description": "Proto representing a window", @@ -14847,9 +14967,9 @@ "description": "Take a snapshot once per day, at the configured hour.", "properties": { "hour": { - "description": "[Beta] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", + "description": "The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" } }, @@ -14866,15 +14986,6 @@ "FRIDAY", "SATURDAY", "SUNDAY" - ], - "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]", - "[Beta]", - "[Beta]", - "[Beta]", - "[Beta]" ] }, "postgres.EndpointGroupSpec": { @@ -14931,15 +15042,15 @@ "description": "Take a snapshot once per month, on the configured day at the configured hour.", "properties": { "day": { - "description": "[Beta] The day of the month on which to take the snapshot, in [1, 31]. In shorter\nmonths the snapshot is taken on the last day instead (day 31 runs on Feb 28\nor 29, and on Apr 30), so every month gets exactly one snapshot.", + "description": "The day of the month on which to take the snapshot, in [1, 31]. In shorter\nmonths the snapshot is taken on the last day instead (day 31 runs on Feb 28\nor 29, and on Apr 30), so every month gets exactly one snapshot.", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" }, "hour": { - "description": "[Beta] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", + "description": "The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" } }, @@ -15101,27 +15212,27 @@ "description": "One cadence at which automatic snapshots are taken.", "properties": { "daily_schedule": { - "description": "[Beta] Take a snapshot once per day.", + "description": "Take a snapshot once per day.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.DailySchedule", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" }, "monthly_schedule": { - "description": "[Beta] Take a snapshot once per month.", + "description": "Take a snapshot once per month.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.MonthlySchedule", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" }, "retention": { - "description": "[Beta] How long snapshots from this cadence are kept before automatic deletion.\nMust be at least 1 hour. Applied when a snapshot is taken; not retroactive,\nso changing it affects only later snapshots.", + "description": "How long snapshots from this cadence are kept before automatic deletion.\nMust be at least 1 hour. Applied when a snapshot is taken; not retroactive,\nso changing it affects only later snapshots.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" }, "weekly_schedule": { - "description": "[Beta] Take a snapshot once per week.", + "description": "Take a snapshot once per week.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.WeeklySchedule", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" } }, @@ -15231,15 +15342,15 @@ "description": "Take a snapshot once per week, on the configured day at the configured hour.", "properties": { "day_of_week": { - "description": "[Beta] The day of the week on which to take the snapshot.", + "description": "The day of the week on which to take the snapshot.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.DayOfWeek", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" }, "hour": { - "description": "[Beta] The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", + "description": "The hour of the day, in UTC, at which to take the snapshot, in [0, 23].", "$ref": "#/$defs/int", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "GA", "x-since-version": "v1.16.0" } }, @@ -16783,8 +16894,8 @@ "MARKDOWN" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]" ] }, "sql.EndpointTagPair": { @@ -17370,6 +17481,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.ClusterPolicyPermission" } }, + "resources.DependsOn": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.DependsOn" + } + }, "resources.InstancePoolPermission": { "type": "array", "items": { From 3185e345ca47426dcf3b2e6a2030c5d1b760d148 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 4 Nov 2026 14:43:26 +0000 Subject: [PATCH 30/31] Update jsonschema_for_docs.json for v1.24.0 --- bundle/schema/jsonschema_for_docs.json | 1374 +++++++++++++++++++++++- 1 file changed, 1322 insertions(+), 52 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 86609947ccb..8a425d7b22f 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -62,10 +62,9 @@ "x-since-version": "v0.279.0" }, "parameters": { - "description": "[Private Preview] A list of parameters to pass into the alert SQL query statement containing parameter markers. Static values only.\n\nReference a parameter in the query text as `:name`. Each parameter must have a unique, non-empty name.\nEach parameter consists of a name, a value, and optionally a type. To represent a NULL\nvalue, the `value` field may be omitted or set to `null` explicitly. If the `type` field\nis omitted, the value is interpreted as a string.\n\nIf the type is given, parameters will be checked for type correctness according\nto the given type. A value is correct if the provided string can be converted to\nthe requested type using the `cast` function. The exact semantics are described in\nthe section [`cast` function](https://docs.databricks.com/sql/language-manual/functions/cast.html) of the SQL language reference.", + "description": "[Beta] A list of parameters to pass into the alert SQL query statement containing parameter markers. Static values only.\n\nReference a parameter in the query text as `:name`. Each parameter must have a unique, non-empty name.\nEach parameter consists of a name, a value, and optionally a type. To represent a NULL\nvalue, the `value` field may be omitted or set to `null` explicitly. If the `type` field\nis omitted, the value is interpreted as a string.\n\nIf the type is given, parameters will be checked for type correctness according\nto the given type. A value is correct if the provided string can be converted to\nthe requested type using the `cast` function. The exact semantics are described in\nthe section [`cast` function](https://docs.databricks.com/sql/language-manual/functions/cast.html) of the SQL language reference.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertStatementParameter", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.10.0" }, "parent_path": { @@ -813,6 +812,47 @@ "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.DataQualityMonitor": { + "type": "object", + "description": "Monitor for the data quality of unity catalog entities such as schema or table.", + "properties": { + "anomaly_detection_config": { + "description": "Anomaly Detection Configuration, applicable to `schema` object types.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.AnomalyDetectionConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "data_profiling_config": { + "description": "Data Profiling Configuration, applicable to `table` object types. Exactly one `Analysis Configuration`\nmust be present.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.DataProfilingConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.24.0" + }, + "object_id": { + "description": "The UUID of the request object. It is `schema_id` for `schema`, and `table_id` for `table`.\n\nFind the `schema_id` from either:\n1. The [schema_id](https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `schema` \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the `table_id` from either:\n1. The [table_id](https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the `table` \u003e go to the `Details` tab \u003e the `Table ID` field.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "object_type": { + "description": "The type of the monitored object. Can be one of the following: `schema` or `table`.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "object_id", + "object_type" + ], + "markdownDescription": "The data_quality_monitor resource allows you to define a [data quality monitor](https://docs.databricks.com/api/workspace/dataquality/createmonitor) on a Unity Catalog schema (anomaly detection) or table (data profiling). It supersedes the `quality_monitor` resource. For information about data quality monitoring, see [link](https://docs.databricks.com/data-governance/unity-catalog/data-quality-monitoring/index.html).\n\nThe bundle manages the schema alert in `anomaly_detection_config.notification_settings`. If it is omitted, deploying an update removes any alert set in the Data Quality Monitoring UI, so define alerts for bundle-managed monitors in the bundle." + }, "resources.DatabaseCatalog": { "type": "object", "properties": { @@ -1354,7 +1394,7 @@ "x-since-version": "v1.20.0" }, "environments": { - "description": "A list of task execution environment specifications that can be referenced by tasks that use serverless compute or a compute resource that uses Environments mode.\n\nFor notebook tasks that use serverless compute or a compute resource that uses Environments mode, 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 tasks that use serverless compute or a compute resource that uses Environments mode, the task environment is required to be specified using environment_key in the task settings.", + "description": "A list of task execution environment specifications that can be referenced by tasks that use serverless compute or a compute resource that uses Environments mode.\n\nFor notebook tasks that use serverless compute or a compute resource that uses Environments mode, 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.\n\nFor other tasks that use serverless compute or a compute resource that uses Environments mode, 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-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" @@ -1713,6 +1753,39 @@ }, "additionalProperties": false }, + "resources.MaterializationSet": { + "type": "object", + "description": "A group of materialized features created and managed as a single unit.", + "properties": { + "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.24.0" + }, + "materialization_set_id": { + "description": "[Private Preview] Server-assigned unique identifier for the materialization set.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "materialized_features": { + "description": "[Private Preview] The materialized features in this set. Order is not significant.\nUpdating the set with a materialized feature removed from this set will cause it to be deleted.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.MaterializedFeature", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "notifications": { + "description": "[Private Preview] Notification configuration around the materialization job or pipeline lifecycle. They are\napplied to every job and pipeline that materializes a feature in this set. Features which are\nmaterialized in the same pipeline will share the same notification.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.MaterializationNotifications", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, "resources.McpService": { "type": "object", "properties": { @@ -3318,7 +3391,7 @@ "x-since-version": "v0.268.0" }, "max_dbu": { - "description": "[Private Preview] Maximum compute capacity of a real-time SQL warehouse, in DBU per hour.\nMust be a multiple of 3 between 3 and 960. The effective maximum cannot be\nlower than the warehouse's minimum capacity.", + "description": "[Private Preview] Maximum compute capacity of a real-time SQL warehouse, in DBU per hour.\nMust be at least the minimum DBU for the selected warehouse size and no greater\nthan the configured DBU limit. Actual capacity may be below this ceiling.", "$ref": "#/$defs/int", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -3734,6 +3807,11 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.Lookup", "x-since-version": "v0.229.0" }, + "sensitive": { + "description": "Whether the variable holds a secret. A variable used as the value of a secret is sensitive by default. The value of a sensitive variable is redacted in the output of `bundle validate -o json`, and the variable can only be used as the value of a sensitive resource field, such as the value of a secret, or in the definition of another sensitive variable.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.24.0" + }, "type": { "description": "The type of the variable.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType", @@ -3762,6 +3840,11 @@ "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" }, + "sensitive": { + "description": "Whether the variable holds a secret. A variable used as the value of a secret is sensitive by default. The value of a sensitive variable is redacted in the output of `bundle validate -o json`, and the variable can only be used as the value of a sensitive resource field, such as the value of a secret, or in the definition of another sensitive variable.", + "$ref": "#/$defs/bool", + "x-since-version": "v1.24.0" + }, "type": { "description": "The type of the variable.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/variable.VariableType", @@ -4137,6 +4220,12 @@ "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" }, + "data_quality_monitors": { + "description": "The data quality monitor definitions for the bundle, where each key is the name of the data quality monitor.", + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.DataQualityMonitor", + "markdownDescription": "The data quality monitor definitions for the bundle, where each key is the name of the data quality monitor. See [data_quality_monitors](https://docs.databricks.com/dev-tools/bundles/resources.html#data_quality_monitors).", + "x-since-version": "v1.24.0" + }, "database_catalogs": { "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.DatabaseCatalog", "x-since-version": "v0.265.0" @@ -4182,6 +4271,12 @@ "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" }, + "materialization_sets": { + "description": "The materialization set definitions for the bundle, where each key is the name of the materialization set.", + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.MaterializationSet", + "markdownDescription": "The materialization set definitions for the bundle, where each key is the name of the materialization set.", + "x-since-version": "v1.24.0" + }, "mcp_services": { "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.McpService", "x-since-version": "v1.17.0" @@ -5452,7 +5547,7 @@ "description": "Behavioral configuration for a ModelProviderService: provider authentication\nand provider-specific fields, the catalog of models this provider\nservice can route to, and the passthrough policy that governs how request\nheaders, query parameters, and unmanaged subpaths cross the trust boundary\nto the upstream provider.", "properties": { "allow_all_targets": { - "description": "When true, accepts any model exposed by the upstream provider; `targets`\nis not required and does not restrict routability. When false, only\nmodels listed in `targets` are routable. Defaults to false.", + "description": "When true, allows models from the provider's built-in model catalog in\naddition to explicit `targets`. When false, only models listed in `targets`\nare routable. Defaults to false. CUSTOM providers have no built-in model\ncatalog and must leave this false and list their models in `targets`.", "$ref": "#/$defs/bool", "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" @@ -5548,7 +5643,7 @@ "x-since-version": "v1.17.0" }, "targets": { - "description": "Models and provider-native API types exposed by this provider service. Each\nentry must include at least one `native_api_types` value. When\n`allow_all_targets` is false, at least one entry is required and model\nservice destinations can reference only listed models. When\n`allow_all_targets` is true, any upstream model is routable; entries in\nthis list provide API-type metadata without restricting other models.", + "description": "Models and provider-native API types exposed by this provider service. Each\nentry must include at least one `native_api_types` value. When\n`allow_all_targets` is false, at least one entry is required and model\nservice destinations can reference only listed models. When\n`allow_all_targets` is true, models from the provider's built-in model\ncatalog are also routable. CUSTOM providers must explicitly list their\nmodels here and cannot enable `allow_all_targets`.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.ModelProviderServiceConfigModelTargetConfig", "x-databricks-launch-stage": "GA", "x-since-version": "v1.17.0" @@ -6455,6 +6550,8 @@ "EXECUTE_CLEAN_ROOM_TASK", "EXTERNAL_USE_SCHEMA", "READ_METADATA", + "CREATE_FEATURE", + "READ_FEATURE", "EXTERNAL_USE_LOCATION" ], "enumDescriptions": [ @@ -6509,6 +6606,8 @@ "", "", "", + "", + "", "[Public Preview]" ] }, @@ -7289,7 +7388,7 @@ "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", + "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`).\n\nSupport 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.\n\nEither `environment_version` or `base_environment` can be provided.\n\nFor more information about Databricks-provided base environments, see the\n[list workspace base environments](:method:Environments/ListWorkspaceBaseEnvironments) API.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v0.289.0" @@ -7309,19 +7408,19 @@ "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.", + "description": "The environment version used by this environment. Either `environment_version` or `base_environment` must be provided.\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-databricks-launch-stage": "GA", "x-since-version": "v0.252.0" }, "java_dependencies": { - "description": "List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`.", + "description": "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-databricks-launch-stage": "GA", "x-since-version": "v0.271.0" }, "project_environment": { - "description": "[Beta] Path to the `pyproject.toml` file that defines the project environment.\nThis field cannot be combined with `environment_version`, `base_environment`, dependency fields,\nor any other environment-source fields. Set the environment version and dependencies in `pyproject.toml` instead.\nFor more information, see the serverless dependencies documentation.", + "description": "[Beta] Path to the `pyproject.toml` file that defines the project environment.\nThis field cannot be combined with `environment_version`, `base_environment`, dependency fields,\nor any other environment-source fields. Set the environment version and dependencies in `pyproject.toml` instead.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.20.0" @@ -8212,6 +8311,348 @@ "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 }, + "dataquality.AggregationGranularity": { + "type": "string", + "description": "The granularity for aggregating data into time windows based on their timestamp.", + "enum": [ + "AGGREGATION_GRANULARITY_5_MINUTES", + "AGGREGATION_GRANULARITY_30_MINUTES", + "AGGREGATION_GRANULARITY_1_HOUR", + "AGGREGATION_GRANULARITY_1_DAY", + "AGGREGATION_GRANULARITY_1_WEEK", + "AGGREGATION_GRANULARITY_2_WEEKS", + "AGGREGATION_GRANULARITY_3_WEEKS", + "AGGREGATION_GRANULARITY_4_WEEKS", + "AGGREGATION_GRANULARITY_1_MONTH", + "AGGREGATION_GRANULARITY_1_YEAR" + ] + }, + "dataquality.AnomalyDetectionConfig": { + "type": "object", + "description": "Anomaly Detection Configurations.", + "properties": { + "excluded_table_full_names": { + "description": "[Beta] List of fully qualified table names to exclude from anomaly detection.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.24.0" + }, + "notification_settings": { + "description": "Who to alert when anomaly detection finds unhealthy tables in this schema. Applicable to\n`schema` monitors only. This is the same schema alert you manage from **Manage alerts** in the\nData Quality Monitoring UI, so a change made in either place shows in both.\n\nSet the recipients in `on_unhealthy_table`; `on_failure` is not supported here. Only\n`destination_ids` and `destination_user_ids` are supported.\n\nOn update, an update mask of `*`, `anomaly_detection_config`, or\n`anomaly_detection_config.notification_settings` replaces the alert's recipients with the ones\nin the request; omitting the field, or leaving both recipient lists empty, removes the alert.\nOther masks leave the alert unchanged.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.NotificationSettings", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, + "dataquality.CronSchedule": { + "type": "object", + "description": "The data quality monitoring workflow cron schedule.", + "properties": { + "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-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "timezone_id": { + "description": "A Java timezone id. The schedule for a job will be resolved with respect to this timezone.\nSee `Java TimeZone \u003chttp://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html\u003e`_ for details.\nThe timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "quartz_cron_expression", + "timezone_id" + ] + }, + "dataquality.CronSchedulePauseStatus": { + "type": "string", + "description": "The data quality monitoring workflow cron schedule pause status.", + "enum": [ + "CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED", + "CRON_SCHEDULE_PAUSE_STATUS_PAUSED" + ] + }, + "dataquality.DataProfilingConfig": { + "type": "object", + "description": "Data Profiling Configurations.", + "properties": { + "assets_dir": { + "description": "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-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "baseline_table_name": { + "description": "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-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "custom_metrics": { + "description": "Custom metrics.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/dataquality.DataProfilingCustomMetric", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "inference_log": { + "description": "`Analysis Configuration` for monitoring inference log tables.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.InferenceLogConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "notification_settings": { + "description": "Field for specifying notification settings.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.NotificationSettings", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "output_schema_id": { + "description": "ID of the schema where output tables are created.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "schedule": { + "description": "The cron schedule.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.CronSchedule", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "skip_builtin_dashboard": { + "description": "Whether to skip creating a default dashboard summarizing data quality metrics.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "slicing_exprs": { + "description": "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-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "snapshot": { + "description": "`Analysis Configuration` for monitoring snapshot tables.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.SnapshotConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "time_series": { + "description": "`Analysis Configuration` for monitoring time series tables.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.TimeSeriesConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.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-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "output_schema_id" + ] + }, + "dataquality.DataProfilingCustomMetric": { + "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-databricks-launch-stage": "GA", + "x-since-version": "v1.24.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-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "name": { + "description": "Name of the metric in the output tables.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "output_data_type": { + "description": "The output type of the custom metric.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "type": { + "description": "The type of the custom metric.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.DataProfilingCustomMetricType", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "definition", + "input_columns", + "name", + "output_data_type", + "type" + ] + }, + "dataquality.DataProfilingCustomMetricType": { + "type": "string", + "description": "The custom metric type.", + "enum": [ + "DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE", + "DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED", + "DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT" + ] + }, + "dataquality.DataProfilingStatus": { + "type": "string", + "description": "The status of the data profiling monitor.", + "enum": [ + "DATA_PROFILING_STATUS_ACTIVE", + "DATA_PROFILING_STATUS_PENDING", + "DATA_PROFILING_STATUS_DELETE_PENDING", + "DATA_PROFILING_STATUS_ERROR", + "DATA_PROFILING_STATUS_FAILED" + ] + }, + "dataquality.InferenceLogConfig": { + "type": "object", + "description": "Inference log configuration.", + "properties": { + "granularities": { + "description": "List of granularities to use when aggregating data into time windows based on their timestamp.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/dataquality.AggregationGranularity", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "label_column": { + "description": "Column for the label.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "model_id_column": { + "description": "Column for the model identifier.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "prediction_column": { + "description": "Column for the prediction.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "problem_type": { + "description": "Problem type the model aims to solve.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.InferenceProblemType", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "timestamp_column": { + "description": "Column for the timestamp.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "granularities", + "model_id_column", + "prediction_column", + "problem_type", + "timestamp_column" + ] + }, + "dataquality.InferenceProblemType": { + "type": "string", + "description": "Inference problem type the model aims to solve.", + "enum": [ + "INFERENCE_PROBLEM_TYPE_CLASSIFICATION", + "INFERENCE_PROBLEM_TYPE_REGRESSION" + ] + }, + "dataquality.NotificationDestination": { + "type": "object", + "description": "Destination of the data quality monitoring notification.", + "properties": { + "destination_ids": { + "description": "The notification-destination IDs (Slack / Teams / webhook) to send the notification to. The\ndestinations must already exist in the workspace; a workspace admin creates them. A maximum of\n25 destination IDs is supported.\nOnly supported on schema monitors, via `anomaly_detection_config`; rejected on table monitors.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "destination_user_ids": { + "description": "The IDs of the workspace users to notify by email. A maximum of 25 user IDs is supported.\nOnly supported on schema monitors, via `anomaly_detection_config`; rejected on table monitors.", + "$ref": "#/$defs/slice/int64", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "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-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, + "dataquality.NotificationSettings": { + "type": "object", + "description": "Settings for sending notifications on the data quality monitoring.", + "properties": { + "on_failure": { + "description": "Destinations to send notifications on failure/timeout.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.NotificationDestination", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "on_unhealthy_table": { + "description": "Recipients to notify when anomaly detection finds unhealthy tables in the schema. Each\nrecipient gets one notification per important unhealthy table. Only supported on schema\nmonitors, via `anomaly_detection_config`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.NotificationDestination", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, + "dataquality.SnapshotConfig": { + "type": "object", + "description": "Snapshot analysis configuration.", + "additionalProperties": false + }, + "dataquality.TimeSeriesConfig": { + "type": "object", + "description": "Time series analysis configuration.", + "properties": { + "granularities": { + "description": "List of granularities to use when aggregating data into time windows based on their timestamp.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/dataquality.AggregationGranularity", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "timestamp_column": { + "description": "Column for the timestamp.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "granularities", + "timestamp_column" + ] + }, "iam.PermissionLevel": { "type": "string", "description": "Permission level", @@ -8260,9 +8701,266 @@ "[Private Preview]" ] }, - "jobs.AiRuntimeTask": { + "jobs.AiClassifyFunction": { "type": "object", - "description": "AiRuntimeTask: multi-node GPU compute task definition for Databricks AI\nRuntime workloads.\n\nJobs-framework-level concepts (retries, per-task timeout, idempotency\ntoken, usage/budget policy, permissions) live on the surrounding\nTaskSettings / run-submit request and are intentionally NOT duplicated\nhere. Users compose `ai_runtime_task` with the standard Jobs/DABs task\nwrapper to get those.", + "description": "Configuration for a task that runs the `ai_classify` function.\n\nThe label set comes from exactly one of two places: `inline_labels`, which\nholds up to 10 labels, or a Unity Catalog table named by `label_table`. Use\n`label_table` for a larger label set.", + "properties": { + "enable_confidence_scores": { + "description": "[Private Preview] When true, includes a per-label confidence score in the response.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "enable_rationales": { + "description": "[Private Preview] When true, includes a rationale explaining each classification in the response.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "inline_labels": { + "description": "[Private Preview] Labels listed inline, for a small label set.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiClassifyFunctionInlineLabels", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "instructions": { + "description": "[Private Preview] Global description of the task and domain, passed to the model to improve\nclassification quality.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "multilabel": { + "description": "[Private Preview] When true, more than one label can be returned for each input.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "version": { + "description": "[Private Preview] The ai_classify function version to invoke (for example, `2.1`).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "version" + ] + }, + "jobs.AiClassifyFunctionInlineLabels": { + "type": "object", + "description": "A label set listed inline.", + "properties": { + "labels": { + "description": "[Private Preview] The labels an input can be classified as. At least two labels are required\nunless `multilabel` is true, which also accepts a single label.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AiClassifyFunctionLabel", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "labels" + ] + }, + "jobs.AiClassifyFunctionLabel": { + "type": "object", + "description": "One label the input can be classified as.", + "properties": { + "description": { + "description": "[Private Preview] Guidance describing what belongs under this label.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "name": { + "description": "[Private Preview] The name returned when an input is classified as this label.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "name" + ] + }, + "jobs.AiExtractFunction": { + "type": "object", + "description": "Configuration for a task that runs the `ai_extract` function.\n\nThe fields to extract come from exactly one of two places: an existing AI\nExtract agent, named by `agent_id`, or the inline `schema` and `instructions`.\nSet `agent_id` or the inline fields, not both.", + "properties": { + "enable_citations": { + "description": "[Private Preview] When true, includes citation metadata locating each extracted value in the\nsource.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "enable_confidence_scores": { + "description": "[Private Preview] When true, includes a per-field confidence score in the response.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "instructions": { + "description": "[Private Preview] Global description of the task and domain, passed to the model to improve\nextraction quality.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "mode": { + "description": "[Private Preview] The extraction mode. Defaults to standard extraction when unspecified.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiExtractFunctionMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "schema": { + "description": "[Private Preview] The extraction schema defining the fields to extract, as a JSON string.\nEither an array of field names (e.g. [\"company\", \"valuation\"]) or an object\nmapping each field name to a type and an optional description. Supported\ntypes are string, integer, number, boolean, enum, object, and array; all\nfields are optional.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "version": { + "description": "[Private Preview] The ai_extract function version to invoke (for example, `2.1`).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "version" + ] + }, + "jobs.AiExtractFunctionMode": { + "type": "string", + "description": "The extraction mode.", + "enum": [ + "MODE_PRECISION" + ], + "enumDescriptions": [ + "[Private Preview]" + ] + }, + "jobs.AiFunctionTask": { + "type": "object", + "description": "A task that applies an AI function to a set of input documents or rows.", + "properties": { + "ai_classify": { + "description": "[Private Preview] Classifies each input document or row into one or more labels.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiClassifyFunction", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "ai_extract": { + "description": "[Private Preview] Extracts structured fields from the input documents or rows.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiExtractFunction", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "ai_parse_document": { + "description": "[Private Preview] Parses the input documents into structured text.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiParseDocumentFunction", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "delta_table": { + "description": "[Private Preview] A Unity Catalog Delta table. The function is applied to each row.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DeltaTableSource", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "output": { + "description": "[Private Preview] Output destination table. When `table` is unset the task generates a stable name from the\nfunction and task identity so a downstream task can reference it.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QualifiedName", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "volume": { + "description": "[Private Preview] A Unity Catalog volume. The function is applied to each file.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.VolumeSource", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "output" + ] + }, + "jobs.AiParseDocumentFunction": { + "type": "object", + "description": "Configuration for a task that runs the `ai_parse_document` function.", + "properties": { + "description_element_types": { + "description": "[Private Preview] Element types to generate AI descriptions for. Leave empty to generate no\ndescriptions; use ALL for every supported type, or list specific types to\nrestrict generation to only those.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AiParseDocumentFunctionDescriptionElementType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "image_output_path": { + "description": "[Private Preview] Unity Catalog volume path where rendered page and element images are written.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "page_range": { + "description": "[Private Preview] Pages to parse (1-indexed), as a comma-separated list of page numbers or\nranges (e.g. \"1,3,5-10\").", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "version": { + "description": "[Private Preview] The ai_parse_document output schema version to invoke (for example, `2.0`).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "version" + ] + }, + "jobs.AiParseDocumentFunctionDescriptionElementType": { + "type": "string", + "description": "An element type that AI descriptions can be generated for.", + "enum": [ + "DESCRIPTION_ELEMENT_TYPE_ALL", + "DESCRIPTION_ELEMENT_TYPE_FIGURE" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" + ] + }, + "jobs.AiRuntimeTask": { + "type": "object", + "description": "AiRuntimeTask: multi-node GPU compute task definition for Databricks AI\nRuntime workloads.\n\nJobs-framework-level concepts (retries, per-task timeout, idempotency\ntoken, usage/budget policy, permissions) live on the surrounding\nTaskSettings / run-submit request and are intentionally NOT duplicated\nhere. Users compose `ai_runtime_task` with the standard Jobs/DABs task\nwrapper to get those.", "properties": { "code_source_path": { "description": "[Private Preview] Workspace or UC volume path of the code-source archive, unpacked on\neach node and exposed through `$CODE_SOURCE`. Set by first-party\ntooling; not for direct callers.", @@ -8818,6 +9516,38 @@ "commands" ] }, + "jobs.DeltaTableSource": { + "type": "object", + "description": "A Unity Catalog Delta table input source. The function is applied to each row.", + "properties": { + "input_column": { + "description": "[Private Preview] Name of the column holding the content the function is applied to.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "merge_key_columns": { + "description": "[Private Preview] Columns that together identify a row across incremental runs, so results can\nbe matched back to their source rows. When unset, the task derives an\nimplicit key from Delta row tracking. If row tracking is also disabled there\nis no stable key, so each run reprocesses the entire source (a full refresh)\nrather than only the changed rows; set a key column or enable row tracking to\nkeep runs incremental.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "table_name": { + "description": "[Private Preview] Fully qualified three-part name of the source table (catalog.schema.table).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "input_column", + "table_name" + ] + }, "jobs.DeploymentSpec": { "type": "object", "description": "DeploymentSpec: configuration for one deployment within an AiRuntimeTask.\nEach entry in `AiRuntimeTask.deployments` describes a group of nodes that\nshare the same command and compute. Many single-program training\nalgorithms use a single entry where every node runs the same command;\nrole-split workloads (driver + worker, parameter server, separate eval\nnode, etc.) use multiple entries.", @@ -9061,6 +9791,12 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, + "serverless_compute": { + "description": "[Beta] Serverless compute settings for this cluster. At most one job cluster per job\nmay set this field; the rate limit defined on the referenced policy applies\nacross all tasks bound to this cluster.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobClusterServerlessCompute", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.24.0" + }, "serverless_compute_id": { "description": "[Private Preview] The ID of the serverless compute object to bind this cluster to. At most one\nJobCluster per job may set this field; the rate limit defined on the referenced\nserverless compute applies across all tasks bound to this cluster.", "$ref": "#/$defs/string", @@ -9074,6 +9810,78 @@ "job_cluster_key" ] }, + "jobs.JobClusterServerlessCompute": { + "type": "object", + "description": "Serverless compute settings for a job cluster.", + "properties": { + "policy_id": { + "description": "[Beta] The ID of the serverless compute policy to apply to this cluster.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, + "jobs.JobCompletionTriggerConfiguration": { + "type": "object", + "description": "A trigger that starts a run after every upstream job completes with a configured status.", + "properties": { + "if_status": { + "description": "[Beta] The status that all upstream jobs must have before this trigger fires. Defaults to SUCCESS.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobCompletionTriggerConfigurationIfStatus", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.24.0" + }, + "jobs": { + "description": "[Beta] The upstream jobs to monitor. Each job must be in a workspace attached to the same Unity Catalog metastore as\nthe downstream job. A maximum of 10 jobs can be monitored.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobCompletionTriggerConfigurationMonitoredJob", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "jobs" + ] + }, + "jobs.JobCompletionTriggerConfigurationIfStatus": { + "type": "string", + "description": "The status that all upstream jobs must have before a job completion trigger fires.", + "enum": [ + "SUCCESS", + "FAILED", + "DONE" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]", + "[Beta]" + ] + }, + "jobs.JobCompletionTriggerConfigurationMonitoredJob": { + "type": "object", + "description": "An upstream job to monitor.", + "properties": { + "job_id": { + "description": "[Beta] The ID of the upstream job.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.24.0" + }, + "workspace_id": { + "description": "[Beta] The ID of the workspace containing the upstream job.\nThis can differ from the caller's workspace and downstream services enforce\ncorrect entitlements and CAN_VIEW permissions for the user + job combination.\nSDR: https://databricks.atlassian.net/browse/SDR-5267", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "job_id", + "workspace_id" + ] + }, "jobs.JobDeployment": { "type": "object", "properties": { @@ -9851,6 +10659,34 @@ "package_name" ] }, + "jobs.QualifiedName": { + "type": "object", + "description": "A three-level Unity Catalog name (catalog.schema.table); any level may be unset.", + "properties": { + "catalog": { + "description": "[Private Preview] Unity Catalog catalog.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "schema": { + "description": "[Private Preview] Unity Catalog schema, within the catalog.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "table": { + "description": "[Private Preview] Table, within the catalog and schema.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, "jobs.QueueSettings": { "type": "object", "properties": { @@ -10292,9 +11128,9 @@ "type": "object", "properties": { "attachment": { - "description": "[Beta] Optional: The configuration for the files attached to the dashboard snapshot notification. It\ncontrols the underlying data of dashboard widgets that is attached as data files and which\npages are included in the attached PDF. If not specified, the notification is sent with only\nthe default snapshot.", + "description": "[Public Preview] Optional: The configuration for the files attached to the dashboard snapshot notification. It\ncontrols the underlying data of dashboard widgets that is attached as data files and which\npages are included in the attached PDF. If not specified, the notification is sent with only\nthe default snapshot.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachment", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" }, "custom_subject": { @@ -10323,15 +11159,15 @@ "description": "The configuration for the files attached to the dashboard snapshot notification sent to\nsubscribers. `data_attachment` describes the underlying data of dashboard widgets attached\nas data files, and `page_attachment` describes which dashboard pages are included in the\nattached PDF.", "properties": { "data_attachment": { - "description": "[Beta] Optional: The configuration for the underlying data of dashboard widgets attached as tabular\ndata files. If not specified, no tabular data is attached.", + "description": "[Public Preview] Optional: The configuration for the underlying data of dashboard widgets attached as tabular\ndata files. If not specified, no tabular data is attached.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachment", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" }, "page_attachment": { - "description": "[Beta] Optional: The selection of dashboard pages included in the attached PDF. If not specified,\nonly the first page is included.", + "description": "[Public Preview] Optional: The selection of dashboard pages included in the attached PDF. If not specified,\nonly the first page is included.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentPageAttachment", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" } }, @@ -10342,21 +11178,21 @@ "description": "The configuration for the tabular data files attached to the dashboard snapshot. `widgets`\nlists the widgets whose data is exported and `file_format` is the output format; each\nreferenced widget's data is exported as a separate file.", "properties": { "file_format": { - "description": "[Beta] The file format of the exported tabular data files.", + "description": "[Public Preview] The file format of the exported tabular data files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachmentFileFormat", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" }, "include_applied_filters": { - "description": "[Beta] When true, the dashboard's applied filter values are included alongside the tabular data as\nan additional attached file.", + "description": "[Public Preview] When true, the dashboard's applied filter values are included alongside the tabular data as\nan additional attached file.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" }, "widgets": { - "description": "[Beta] The widgets whose underlying data is exported. At least one widget must be referenced.", + "description": "[Public Preview] The widgets whose underlying data is exported. At least one widget must be referenced.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentDataAttachmentWidget", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" } }, @@ -10375,9 +11211,9 @@ "FILE_FORMAT_EXCEL" ], "enumDescriptions": [ - "[Beta]", - "[Beta]", - "[Beta]" + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "jobs.SubscriptionAttachmentDataAttachmentWidget": { @@ -10385,15 +11221,15 @@ "description": "Identifies a dashboard widget whose data to attach. `page_id` and `widget_id` are\nthe URL identifiers from the dashboard's serialized definition returned by the Get dashboard\nAPI (`serialized_dashboard`), and together they uniquely identify the widget.", "properties": { "page_id": { - "description": "[Beta] The URL identifier of the page containing the widget. This is the value of the `name`\nfield of the corresponding entry under `pages` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "description": "[Public Preview] The URL identifier of the page containing the widget. This is the value of the `name`\nfield of the corresponding entry under `pages` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" }, "widget_id": { - "description": "[Beta] The URL identifier of the widget. This is the value of the `name` field of the\ncorresponding widget under that page's `layout` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "description": "[Public Preview] The URL identifier of the widget. This is the value of the `name` field of the\ncorresponding widget under that page's `layout` in the serialized dashboard definition.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" } }, @@ -10408,15 +11244,15 @@ "description": "The selection of dashboard pages included in the attached PDF. `page_selection` chooses\nbetween all pages, the first page only, or an explicit subset listed in `page_ids`.", "properties": { "page_ids": { - "description": "[Beta] The identifiers of the pages to include in the PDF. Only specified when `page_selection` is\n`PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's\nserialized definition returned by the Get dashboard API (`serialized_dashboard`): the value\nof the `name` field of an entry under `pages`.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", + "description": "[Public Preview] The identifiers of the pages to include in the PDF. Only specified when `page_selection` is\n`PAGE_SELECTION_SUBSET`. Each value is the identifier of a page in the dashboard's\nserialized definition returned by the Get dashboard API (`serialized_dashboard`): the value\nof the `name` field of an entry under `pages`.\nFormat: alphanumeric, hyphen, and underscore characters allowed, max length 63.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" }, "page_selection": { - "description": "[Beta] How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to\ninclude are listed in `page_ids`.", + "description": "[Public Preview] How the attached pages are selected. When set to `PAGE_SELECTION_SUBSET`, the pages to\ninclude are listed in `page_ids`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionAttachmentPageAttachmentPageSelection", - "x-databricks-launch-stage": "PUBLIC_BETA", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v1.22.0" } }, @@ -10430,8 +11266,8 @@ "PAGE_SELECTION_SUBSET" ], "enumDescriptions": [ - "[Beta]", - "[Beta]" + "[Public Preview]", + "[Public Preview]" ] }, "jobs.SubscriptionSubscriber": { @@ -10488,6 +11324,13 @@ "jobs.Task": { "type": "object", "properties": { + "ai_function_task": { + "description": "[Private Preview] Applies an AI function to a set of input documents or rows.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiFunctionTask", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, "ai_runtime_task": { "description": "[Public Preview] The task runs a multi-gpu compute workload on Databricks AI Runtime. Specify\nthe accelerator type and count, the command to run, and where the workload's\ncode and MLflow output are stored.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiRuntimeTask", @@ -10873,6 +11716,12 @@ "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.13.0" }, + "job_completion": { + "description": "[Beta] Job completion trigger configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobCompletionTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.24.0" + }, "model": { "description": "[Private Preview] Model trigger configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", @@ -10923,6 +11772,12 @@ "x-databricks-launch-stage": "GA", "x-since-version": "v0.229.0" }, + "job_completion": { + "description": "[Beta] Job completion trigger settings.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobCompletionTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.24.0" + }, "model": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", @@ -10957,6 +11812,23 @@ }, "additionalProperties": false }, + "jobs.VolumeSource": { + "type": "object", + "description": "A Unity Catalog volume input source. The function is applied to each file.", + "properties": { + "volume_path": { + "description": "[Private Preview] Unity Catalog volume path to the input files\n(e.g. `/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/...`).", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "volume_path" + ] + }, "jobs.Webhook": { "type": "object", "properties": { @@ -11282,12 +12154,51 @@ "description": "The input column from which the count is computed. For Kafka sources, use dot-prefixed path\nnotation (e.g., \"value.amount\"). For nested fields, the leaf node name is used.\nColon-prefixed notation (e.g., \"value:amount\") is supported for backwards\ncompatibility but is deprecated; migrate to dot notation.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", - "x-since-version": "v1.22.0" + "x-since-version": "v1.22.0" + } + }, + "additionalProperties": false, + "required": [ + "input" + ] + }, + "ml.CronSchedule": { + "type": "object", + "description": "A cron-based schedule trigger for the materialization pipeline.", + "properties": { + "cron_expression": { + "description": "The cron expression defining the schedule (e.g., \"0 0 * * *\" for daily at midnight). The\nschedule is interpreted in timezone_id (defaults to UTC). Required when mode is MANUAL (or\nunset). Left empty when mode is DERIVED, where the service computes it (aligned to UTC) from\nthe features' window timing and fills it in on the response.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "mode": { + "description": "[Private Preview] How the schedule is determined. Defaults to MANUAL when unset.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.CronScheduleMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "timezone_id": { + "description": "[Private Preview] A Java timezone ID. The schedule is resolved with respect to this timezone. Defaults to UTC\nwhen omitted. Can only be configured for MANUAL schedules; DERIVED schedules are always aligned\nto UTC.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" } }, - "additionalProperties": false, - "required": [ - "input" + "additionalProperties": false + }, + "ml.CronScheduleMode": { + "type": "string", + "description": "The way a materialization schedule is arrived at.", + "enum": [ + "MANUAL", + "DERIVED" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, "ml.CustomUdf": { @@ -11883,6 +12794,173 @@ }, "additionalProperties": false }, + "ml.MaterializationFailureNotification": { + "type": "object", + "description": "Recipients to notify when a materialization run fails.", + "properties": { + "destination_ids": { + "description": "[Private Preview] IDs of the notification destinations (for example Slack, Microsoft Teams, PagerDuty, or a\ngeneric webhook) to notify. Not supported for streaming materialized features.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "email_addresses": { + "description": "[Private Preview] Email addresses to notify.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "final_attempt_only": { + "description": "[Private Preview] If true, notify only when the final attempt of a run fails. If false or unset, notify on\nevery failed attempt, including attempts that will be retried.\n\nBatch materialization does not retry failures that need a fix on your side, such as missing\npermissions or invalid configuration, so the first attempt is the final one. Other batch\nfailures are retried up to twice.\n\nStreaming materialization restarts a failed update indefinitely unless the error cannot be\nretried. With this set, a streaming materialized feature notifies only on errors that cannot\nbe retried, and never on failures that are restarted.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, + "ml.MaterializationNotifications": { + "type": "object", + "description": "Notifications for the jobs and pipelines that materialize the features in a set, one field per\ntrigger.", + "properties": { + "on_failure": { + "description": "[Private Preview] Who to notify when a run fails, and on which attempts.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.MaterializationFailureNotification", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "on_success": { + "description": "[Private Preview] Who to notify when a run succeeds.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.MaterializationSuccessNotification", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, + "ml.MaterializationSuccessNotification": { + "type": "object", + "description": "Recipients to notify when a materialization run succeeds.", + "properties": { + "destination_ids": { + "description": "[Private Preview] IDs of the notification destinations (for example Slack, Microsoft Teams, PagerDuty, or a\ngeneric webhook) to notify. Not supported for streaming materialized features.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "email_addresses": { + "description": "[Private Preview] Email addresses to notify.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, + "ml.MaterializedFeature": { + "type": "object", + "description": "A materialized feature represents a feature that is continuously computed and stored.", + "properties": { + "budget_policy_id": { + "description": "[Private Preview] The ID of the budget policy used to attribute the serverless compute cost of this\nmaterialization. If not specified, a default budget policy may be applied.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "cron_schedule": { + "description": "[Private Preview] Deprecated: setting this field is rejected. Use `cron_schedule_trigger` instead.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.24.0", + "deprecated": true + }, + "cron_schedule_trigger": { + "description": "A cron-based schedule trigger for the materialization pipeline.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.CronSchedule", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "feature_name": { + "description": "The full name of the feature in Unity Catalog.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "materialized_feature_id": { + "description": "Server-assigned unique identifier for the materialized feature.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "offline_store_config": { + "description": "Destination for writing feature values to an offline Delta table. The resulting table is\nreturned as `table_name`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.OfflineStoreConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "online_store_config": { + "description": "Destination for writing feature values to an online Lakebase table. The resulting table is\nreturned as `table_name`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.OnlineStoreConfig", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "pipeline_schedule_state": { + "description": "[Private Preview] Deprecated: This legacy pipeline setting does not control batch job scheduling.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.MaterializedFeaturePipelineScheduleState", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, + "x-since-version": "v1.24.0", + "deprecated": true + }, + "streaming_mode": { + "description": "The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets\nsub-second latency for operational workloads; micro-batch mode (MBM) favors cost efficiency\nfor ETL and analytics workloads.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.StreamingMode", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "table_trigger": { + "description": "A trigger that fires when the upstream source table changes.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.TableTrigger", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "tags": { + "description": "[Private Preview] Custom tags to associate with this materialization. They are applied to the materialization\njob (for batch features) or pipeline (for streaming features) and forwarded to the underlying\ncompute as cluster tags, so materialization cost can be attributed in the billing system\ntables. These tags apply only to the materialization compute; they are not applied to the\nUnity Catalog Feature resource itself, whose tags are managed separately through the Unity\nCatalog tagging API. A maximum of 25 tags is supported; keys and values are subject to the\nsame limitations as cluster tags.", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "feature_name" + ] + }, + "ml.MaterializedFeaturePipelineScheduleState": { + "type": "string", + "enum": [ + "SNAPSHOT", + "ACTIVE", + "PAUSED" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" + ] + }, "ml.MaxFunction": { "type": "object", "description": "Computes the maximum value.", @@ -11934,6 +13012,73 @@ }, "additionalProperties": false }, + "ml.OfflineStoreConfig": { + "type": "object", + "description": "Configuration for offline store destination.", + "properties": { + "catalog_name": { + "description": "The Unity Catalog catalog name.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "schema_name": { + "description": "The Unity Catalog schema name.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "table_name_prefix": { + "description": "Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a table with this prefix and a generated postfix.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "catalog_name", + "schema_name", + "table_name_prefix" + ] + }, + "ml.OnlineStoreConfig": { + "type": "object", + "description": "Configuration for online store destination.", + "properties": { + "catalog_name": { + "description": "The Unity Catalog catalog name. This name is also used as the Lakebase logical database name.\nQuoting is handled by the backend where needed, do not pre-quote it.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "online_store_name": { + "description": "The name of the target online store.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "schema_name": { + "description": "The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database.\nQuoting is handled by the backend where needed, do not pre-quote it.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "table_name_prefix": { + "description": "Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a Lakebase table with this prefix and a generated postfix.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false, + "required": [ + "catalog_name", + "online_store_name", + "schema_name", + "table_name_prefix" + ] + }, "ml.RegisteredModelPermissionLevel": { "type": "string", "description": "Permission level", @@ -12202,6 +13347,40 @@ "full_name" ] }, + "ml.StreamingMode": { + "type": "object", + "description": "The streaming mode configuration for a streaming materialization pipeline.", + "properties": { + "freshness_target": { + "description": "[Private Preview] The desired data freshness for feature materialization, expressed as a\nduration string (e.g. \"1 minute\").", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "mode": { + "description": "The type of streaming mode used by the materialization pipeline.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.StreamingModeStreamingModeType", + "x-databricks-launch-stage": "GA", + "x-since-version": "v1.24.0" + }, + "shuffle_partitions": { + "description": "[Private Preview] Number of shuffle partitions for streaming materialization of this feature.\nHigher values process high-throughput features with more parallelism at higher compute cost.\nMaterialized features which are computed together will use the largest value set among them.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, + "ml.StreamingModeStreamingModeType": { + "type": "string", + "enum": [ + "STREAMING_MODE_TYPE_RTM", + "STREAMING_MODE_TYPE_MBM" + ] + }, "ml.SumFunction": { "type": "object", "description": "Computes the sum of values.", @@ -12218,6 +13397,46 @@ "input" ] }, + "ml.TableTrigger": { + "type": "object", + "description": "A trigger that fires when the feature's source table changes: a DeltaTableSource's table, or an\nSdpSource's input_tables.", + "properties": { + "condition": { + "description": "[Private Preview] Which source table updates trigger a materialization run. If not set, any source table update\ntriggers a run.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.TableTriggerTableTriggerCondition", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "min_time_between_triggers": { + "description": "[Private Preview] The minimum time between two triggered runs, so a frequently updated source table does not\ntrigger runs too often. If not set, a feature with a sliding window uses half its\nslide_duration and a feature with a tumbling window uses half its window_duration, clamped to\nbetween 5 minutes and 1 hour. Other features have no minimum.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + }, + "wait_after_last_change": { + "description": "[Private Preview] How long the source table must go without updates before a run starts, so a series of\nupdates settles before the run. If not set, a run starts as soon as the source table updates.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.24.0" + } + }, + "additionalProperties": false + }, + "ml.TableTriggerTableTriggerCondition": { + "type": "string", + "description": "Which source table updates trigger a materialization run.", + "enum": [ + "TABLE_TRIGGER_CONDITION_ANY_UPDATED", + "TABLE_TRIGGER_CONDITION_ALL_UPDATED" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" + ] + }, "ml.TimeWindow": { "type": "object", "properties": { @@ -12249,7 +13468,7 @@ "x-since-version": "v1.22.0" }, "start_time": { - "description": "[Private Preview] Earliest event-time boundary at which the Feature may emit an output. This gates outputs, not\nthe historical inputs read by a window. For example, a 365-day window with\nstart_time=2026-01-01 begins emitting partial-window values on that date instead of waiting\nfor 365 days of data; a lifetime window produces no output before start_time. If unset,\ntumbling and fixed-duration sliding windows first emit at an offset-aligned boundary after a\nfull window can be formed. If unset, lifetime sliding windows and rolling windows emit as soon as\neligible source data exists.\nNot currently supported for sawtooth windows or for Features with a stream source.", + "description": "[Private Preview] Earliest event-time boundary at which the Feature may emit an output. This gates outputs, not\nthe historical inputs read by a window. For example, a 365-day window with\nstart_time=2026-01-01 begins emitting partial-window values on that date instead of waiting\nfor 365 days of data; a lifetime window produces no output before start_time. If unset,\ntumbling and fixed-duration sliding windows first emit at an offset-aligned boundary after a\nfull window can be formed. If unset, lifetime sliding windows and rolling windows emit as soon as\neligible source data exists.\nFor sawtooth windows, start_time must not be later than the time the Feature is created.\nNot supported for rolling windows on Features with a stream source.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -16619,24 +17838,21 @@ "description": "A named parameter bound to the alert query. Only flat, named scalar parameters are\nsupported; complex types such as ARRAY, MAP, and STRUCT are not.", "properties": { "name": { - "description": "[Private Preview] The name of the parameter. Reference it in the query text as `:name`. Required, must be\nnon-empty, and must be unique across the alert's parameters.", + "description": "[Beta] The name of the parameter. Reference it in the query text as `:name`. Required, must be\nnon-empty, and must be unique across the alert's parameters.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.10.0" }, "type": { - "description": "[Private Preview] The SQL data type of the parameter, for example `STRING`, `INT`, or `DECIMAL(10, 2)`. If no type is given\nthe type is assumed to be `STRING`. Complex types such as `ARRAY`, `MAP`, and `STRUCT` are not supported.", + "description": "[Beta] The SQL data type of the parameter, for example `STRING`, `INT`, or `DECIMAL(10, 2)`. If no type is given\nthe type is assumed to be `STRING`. Complex types such as `ARRAY`, `MAP`, and `STRUCT` are not supported.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.10.0" }, "value": { - "description": "[Private Preview] The value bound to the parameter, represented as a string. If omitted, the value is interpreted as NULL.", + "description": "[Beta] The value bound to the parameter, represented as a string. If omitted, the value is interpreted as NULL.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.10.0" } }, @@ -17205,6 +18421,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Dashboard" } }, + "resources.DataQualityMonitor": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.DataQualityMonitor" + } + }, "resources.DatabaseCatalog": { "type": "object", "additionalProperties": { @@ -17253,6 +18475,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.JobRun" } }, + "resources.MaterializationSet": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.MaterializationSet" + } + }, "resources.McpService": { "type": "object", "additionalProperties": { @@ -17660,6 +18888,30 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpecTypeOverride" } }, + "dataquality.AggregationGranularity": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.AggregationGranularity" + } + }, + "dataquality.DataProfilingCustomMetric": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/dataquality.DataProfilingCustomMetric" + } + }, + "jobs.AiClassifyFunctionLabel": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiClassifyFunctionLabel" + } + }, + "jobs.AiParseDocumentFunctionDescriptionElementType": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiParseDocumentFunctionDescriptionElementType" + } + }, "jobs.AlertTaskSubscriber": { "type": "array", "items": { @@ -17678,6 +18930,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobCluster" } }, + "jobs.JobCompletionTriggerConfigurationMonitoredJob": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobCompletionTriggerConfigurationMonitoredJob" + } + }, "jobs.JobEnvironment": { "type": "array", "items": { @@ -17798,6 +19056,12 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.InputBinding" } }, + "ml.MaterializedFeature": { + "type": "array", + "items": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.MaterializedFeature" + } + }, "ml.ModelTag": { "type": "array", "items": { @@ -17970,6 +19234,12 @@ } } }, + "int64": { + "type": "array", + "items": { + "$ref": "#/$defs/int64" + } + }, "string": { "type": "array", "items": { From c0e8d06f0f5b06a80d7a0143cd0c28fd84416731 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 9 Nov 2026 13:01:00 +0000 Subject: [PATCH 31/31] Update jsonschema_for_docs.json for v1.25.0 --- bundle/schema/jsonschema_for_docs.json | 297 +++++++++++++++---------- 1 file changed, 185 insertions(+), 112 deletions(-) diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 8a425d7b22f..34068bb30ce 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -1281,7 +1281,7 @@ "x-since-version": "v1.9.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 [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.", + "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 [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.\nThe node type cannot be changed after the pool is created.", "$ref": "#/$defs/string", "x-databricks-launch-stage": "GA", "x-since-version": "v1.9.0" @@ -1770,7 +1770,7 @@ "x-since-version": "v1.24.0" }, "materialized_features": { - "description": "[Private Preview] The materialized features in this set. Order is not significant.\nUpdating the set with a materialized feature removed from this set will cause it to be deleted.", + "description": "[Private Preview] The materialized features in this set. Order is not significant.\nAn `UpdateMaterializationSet` request with `materialized_features` or `*`\nin its update mask deletes omitted materialized features.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.MaterializedFeature", "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, @@ -2553,6 +2553,91 @@ ], "x-databricks-launch-stage": "PUBLIC_BETA" }, + "resources.PostgresDataApi": { + "type": "object", + "description": "[Private Preview] The Data API (a PostgREST-compatible REST interface) of a Postgres database on a Lakebase Autoscaling branch. A database has at most one Data API. At least one setting besides `parent` is required, such as `db_schemas`. Its serving URL is available as `status.url`; reference it as `${resources.postgres_data_apis.\u003ckey\u003e.status.url}`. Durations use the protobuf seconds format, such as `300s`.", + "properties": { + "db_aggregates_enabled": { + "description": "[Private Preview] Enable aggregate functions (count, sum, avg, etc.) in Data API responses.\nDefault: true.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.25.0" + }, + "db_extra_search_path": { + "description": "[Private Preview] Additional schemas to include in the PostgreSQL search path.\nEach entry must be a valid PostgreSQL schema name.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.25.0" + }, + "db_max_rows": { + "description": "[Private Preview] Maximum number of rows returned in a single Data API response.\nMust be a positive integer.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.25.0" + }, + "db_schemas": { + "description": "[Private Preview] Database schemas exposed through the Data API.\nEach entry must be a valid PostgreSQL schema name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*).\nMaximum 100 entries. Default: [\"public\"].", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.25.0" + }, + "jwt_cache_max_lifetime": { + "description": "[Private Preview] Maximum lifetime for cached JWT tokens. Zero duration disables caching.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.25.0" + }, + "jwt_role_claim_key": { + "description": "[Private Preview] JSON path to the role claim in JWT tokens (e.g., \".sub\").\nDefault: \".sub\".", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.25.0" + }, + "lifecycle": { + "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.25.0" + }, + "openapi_mode": { + "description": "[Private Preview] OpenAPI documentation mode for the Data API endpoint.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.OpenApiMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.25.0" + }, + "parent": { + "description": "The database whose Data API this manages. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}", + "$ref": "#/$defs/string", + "x-since-version": "v1.25.0" + }, + "server_cors_allowed_origins": { + "description": "[Private Preview] Allowed origins for CORS requests.\nEach entry should be a valid origin URL, or use \"*\" to allow all origins.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.25.0" + }, + "server_timing_enabled": { + "description": "[Private Preview] Enable the Server-Timing header in Data API responses.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, + "x-since-version": "v1.25.0" + } + }, + "additionalProperties": false, + "required": [ + "parent" + ], + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true + }, "resources.PostgresDatabase": { "type": "object", "description": "[Beta]", @@ -4317,6 +4402,11 @@ "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresCatalog", "x-since-version": "v1.0.0" }, + "postgres_data_apis": { + "description": "The Postgres Data API definitions for the bundle, where each key is the name of the Data API. Each entry enables and configures the Data API (a REST interface) of a database on a Lakebase Autoscaling branch. Removing an entry turns off the Data API; the database and its data are not affected.", + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresDataApi", + "x-since-version": "v1.25.0" + }, "postgres_databases": { "description": "The Postgres database definitions for the bundle, where each key is the name of the database. Each entry defines a database on a Lakebase Autoscaling branch.", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresDatabase", @@ -8586,7 +8676,7 @@ "description": "Destination of the data quality monitoring notification.", "properties": { "destination_ids": { - "description": "The notification-destination IDs (Slack / Teams / webhook) to send the notification to. The\ndestinations must already exist in the workspace; a workspace admin creates them. A maximum of\n25 destination IDs is supported.\nOnly supported on schema monitors, via `anomaly_detection_config`; rejected on table monitors.", + "description": "The notification-destination IDs (Slack / Teams / webhook / Asana / ServiceNow / AWS\nEventBridge) to send the notification to. The destinations must already exist in the\nworkspace; a workspace admin creates them. A maximum of 25 destination IDs is supported.\nOnly supported on schema monitors, via `anomaly_detection_config`; rejected on table monitors.", "$ref": "#/$defs/slice/string", "x-databricks-launch-stage": "GA", "x-since-version": "v1.24.0" @@ -8706,45 +8796,39 @@ "description": "Configuration for a task that runs the `ai_classify` function.\n\nThe label set comes from exactly one of two places: `inline_labels`, which\nholds up to 10 labels, or a Unity Catalog table named by `label_table`. Use\n`label_table` for a larger label set.", "properties": { "enable_confidence_scores": { - "description": "[Private Preview] When true, includes a per-label confidence score in the response.", + "description": "[Beta] When true, includes a per-label confidence score in the response.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "enable_rationales": { - "description": "[Private Preview] When true, includes a rationale explaining each classification in the response.", + "description": "[Beta] When true, includes a rationale explaining each classification in the response.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "inline_labels": { - "description": "[Private Preview] Labels listed inline, for a small label set.", + "description": "[Beta] Labels listed inline, for a small label set.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiClassifyFunctionInlineLabels", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "instructions": { - "description": "[Private Preview] Global description of the task and domain, passed to the model to improve\nclassification quality.", + "description": "[Beta] Global description of the task and domain, passed to the model to improve\nclassification quality.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "multilabel": { - "description": "[Private Preview] When true, more than one label can be returned for each input.", + "description": "[Beta] When true, more than one label can be returned for each input.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "version": { - "description": "[Private Preview] The ai_classify function version to invoke (for example, `2.1`).", + "description": "[Beta] The ai_classify function version to invoke (for example, `2.1`).", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" } }, @@ -8758,10 +8842,9 @@ "description": "A label set listed inline.", "properties": { "labels": { - "description": "[Private Preview] The labels an input can be classified as. At least two labels are required\nunless `multilabel` is true, which also accepts a single label.", + "description": "[Beta] The labels an input can be classified as. At least two labels are required\nunless `multilabel` is true, which also accepts a single label.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AiClassifyFunctionLabel", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" } }, @@ -8775,17 +8858,15 @@ "description": "One label the input can be classified as.", "properties": { "description": { - "description": "[Private Preview] Guidance describing what belongs under this label.", + "description": "[Beta] Guidance describing what belongs under this label.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "name": { - "description": "[Private Preview] The name returned when an input is classified as this label.", + "description": "[Beta] The name returned when an input is classified as this label.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" } }, @@ -8799,45 +8880,39 @@ "description": "Configuration for a task that runs the `ai_extract` function.\n\nThe fields to extract come from exactly one of two places: an existing AI\nExtract agent, named by `agent_id`, or the inline `schema` and `instructions`.\nSet `agent_id` or the inline fields, not both.", "properties": { "enable_citations": { - "description": "[Private Preview] When true, includes citation metadata locating each extracted value in the\nsource.", + "description": "[Beta] When true, includes citation metadata locating each extracted value in the\nsource.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "enable_confidence_scores": { - "description": "[Private Preview] When true, includes a per-field confidence score in the response.", + "description": "[Beta] When true, includes a per-field confidence score in the response.", "$ref": "#/$defs/bool", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "instructions": { - "description": "[Private Preview] Global description of the task and domain, passed to the model to improve\nextraction quality.", + "description": "[Beta] Global description of the task and domain, passed to the model to improve\nextraction quality.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "mode": { - "description": "[Private Preview] The extraction mode. Defaults to standard extraction when unspecified.", + "description": "[Beta] The extraction mode. Defaults to standard extraction when unspecified.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiExtractFunctionMode", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "schema": { - "description": "[Private Preview] The extraction schema defining the fields to extract, as a JSON string.\nEither an array of field names (e.g. [\"company\", \"valuation\"]) or an object\nmapping each field name to a type and an optional description. Supported\ntypes are string, integer, number, boolean, enum, object, and array; all\nfields are optional.", + "description": "[Beta] The extraction schema defining the fields to extract, as a JSON string.\nEither an array of field names (e.g. [\"company\", \"valuation\"]) or an object\nmapping each field name to a type and an optional description. Supported\ntypes are string, integer, number, boolean, enum, object, and array; all\nfields are optional.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "version": { - "description": "[Private Preview] The ai_extract function version to invoke (for example, `2.1`).", + "description": "[Beta] The ai_extract function version to invoke (for example, `2.1`).", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" } }, @@ -8853,7 +8928,7 @@ "MODE_PRECISION" ], "enumDescriptions": [ - "[Private Preview]" + "[Beta]" ] }, "jobs.AiFunctionTask": { @@ -8861,45 +8936,39 @@ "description": "A task that applies an AI function to a set of input documents or rows.", "properties": { "ai_classify": { - "description": "[Private Preview] Classifies each input document or row into one or more labels.", + "description": "[Beta] Classifies each input document or row into one or more labels.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiClassifyFunction", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "ai_extract": { - "description": "[Private Preview] Extracts structured fields from the input documents or rows.", + "description": "[Beta] Extracts structured fields from the input documents or rows.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiExtractFunction", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "ai_parse_document": { - "description": "[Private Preview] Parses the input documents into structured text.", + "description": "[Beta] Parses the input documents into structured text.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiParseDocumentFunction", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "delta_table": { - "description": "[Private Preview] A Unity Catalog Delta table. The function is applied to each row.", + "description": "[Beta] A Unity Catalog Delta table. The function is applied to each row.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DeltaTableSource", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "output": { - "description": "[Private Preview] Output destination table. When `table` is unset the task generates a stable name from the\nfunction and task identity so a downstream task can reference it.", + "description": "[Beta] Output destination table. When `table` is unset the task generates a stable name from the\nfunction and task identity so a downstream task can reference it.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QualifiedName", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "volume": { - "description": "[Private Preview] A Unity Catalog volume. The function is applied to each file.", + "description": "[Beta] A Unity Catalog volume. The function is applied to each file.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.VolumeSource", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" } }, @@ -8913,31 +8982,27 @@ "description": "Configuration for a task that runs the `ai_parse_document` function.", "properties": { "description_element_types": { - "description": "[Private Preview] Element types to generate AI descriptions for. Leave empty to generate no\ndescriptions; use ALL for every supported type, or list specific types to\nrestrict generation to only those.", + "description": "[Beta] Element types to generate AI descriptions for. Leave empty to generate no\ndescriptions; use ALL for every supported type, or list specific types to\nrestrict generation to only those.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AiParseDocumentFunctionDescriptionElementType", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "image_output_path": { - "description": "[Private Preview] Unity Catalog volume path where rendered page and element images are written.", + "description": "[Beta] Unity Catalog volume path where rendered page and element images are written.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "page_range": { - "description": "[Private Preview] Pages to parse (1-indexed), as a comma-separated list of page numbers or\nranges (e.g. \"1,3,5-10\").", + "description": "[Beta] Pages to parse (1-indexed), as a comma-separated list of page numbers or\nranges (e.g. \"1,3,5-10\").", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "version": { - "description": "[Private Preview] The ai_parse_document output schema version to invoke (for example, `2.0`).", + "description": "[Beta] The ai_parse_document output schema version to invoke (for example, `2.0`).", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" } }, @@ -8954,8 +9019,8 @@ "DESCRIPTION_ELEMENT_TYPE_FIGURE" ], "enumDescriptions": [ - "[Private Preview]", - "[Private Preview]" + "[Beta]", + "[Beta]" ] }, "jobs.AiRuntimeTask": { @@ -9032,11 +9097,9 @@ "description": "Scheduling priority class for a workload — its priority and preemptability\nwhen the scheduler ranks pending work.", "enum": [ "BEST_EFFORT", - "NORMAL", - "CRITICAL" + "NORMAL" ], "enumDescriptions": [ - "[Private Preview]", "[Private Preview]", "[Private Preview]" ] @@ -9521,24 +9584,21 @@ "description": "A Unity Catalog Delta table input source. The function is applied to each row.", "properties": { "input_column": { - "description": "[Private Preview] Name of the column holding the content the function is applied to.", + "description": "[Beta] Name of the column holding the content the function is applied to.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "merge_key_columns": { - "description": "[Private Preview] Columns that together identify a row across incremental runs, so results can\nbe matched back to their source rows. When unset, the task derives an\nimplicit key from Delta row tracking. If row tracking is also disabled there\nis no stable key, so each run reprocesses the entire source (a full refresh)\nrather than only the changed rows; set a key column or enable row tracking to\nkeep runs incremental.", + "description": "[Beta] Columns that together identify a row across incremental runs, so results can\nbe matched back to their source rows. When unset, the task derives an\nimplicit key from Delta row tracking. If row tracking is also disabled there\nis no stable key, so each run reprocesses the entire source (a full refresh)\nrather than only the changed rows; set a key column or enable row tracking to\nkeep runs incremental.", "$ref": "#/$defs/slice/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "table_name": { - "description": "[Private Preview] Fully qualified three-part name of the source table (catalog.schema.table).", + "description": "[Beta] Fully qualified three-part name of the source table (catalog.schema.table).", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" } }, @@ -10664,24 +10724,21 @@ "description": "A three-level Unity Catalog name (catalog.schema.table); any level may be unset.", "properties": { "catalog": { - "description": "[Private Preview] Unity Catalog catalog.", + "description": "[Beta] Unity Catalog catalog.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "schema": { - "description": "[Private Preview] Unity Catalog schema, within the catalog.", + "description": "[Beta] Unity Catalog schema, within the catalog.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "table": { - "description": "[Private Preview] Table, within the catalog and schema.", + "description": "[Beta] Table, within the catalog and schema.", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" } }, @@ -11325,10 +11382,9 @@ "type": "object", "properties": { "ai_function_task": { - "description": "[Private Preview] Applies an AI function to a set of input documents or rows.", + "description": "[Beta] Applies an AI function to a set of input documents or rows.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiFunctionTask", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" }, "ai_runtime_task": { @@ -11817,10 +11873,9 @@ "description": "A Unity Catalog volume input source. The function is applied to each file.", "properties": { "volume_path": { - "description": "[Private Preview] Unity Catalog volume path to the input files\n(e.g. `/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/...`).", + "description": "[Beta] Unity Catalog volume path to the input files\n(e.g. `/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/...`).", "$ref": "#/$defs/string", - "x-databricks-launch-stage": "PRIVATE_PREVIEW", - "doNotSuggest": true, + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v1.24.0" } }, @@ -12164,7 +12219,7 @@ }, "ml.CronSchedule": { "type": "object", - "description": "A cron-based schedule trigger for the materialization pipeline.", + "description": "A cron-based schedule trigger for batch materialization.", "properties": { "cron_expression": { "description": "The cron expression defining the schedule (e.g., \"0 0 * * *\" for daily at midnight). The\nschedule is interpreted in timezone_id (defaults to UTC). Required when mode is MANUAL (or\nunset). Left empty when mode is DERIVED, where the service computes it (aligned to UTC) from\nthe features' window timing and fills it in on the response.", @@ -12885,7 +12940,7 @@ "deprecated": true }, "cron_schedule_trigger": { - "description": "A cron-based schedule trigger for the materialization pipeline.", + "description": "A cron-based schedule trigger for batch materialization.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.CronSchedule", "x-databricks-launch-stage": "GA", "x-since-version": "v1.24.0" @@ -12930,7 +12985,7 @@ "x-since-version": "v1.24.0" }, "table_trigger": { - "description": "A trigger that fires when the upstream source table changes.", + "description": "A trigger that starts batch materialization when the upstream source table changes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/ml.TableTrigger", "x-databricks-launch-stage": "GA", "x-since-version": "v1.24.0" @@ -13399,7 +13454,7 @@ }, "ml.TableTrigger": { "type": "object", - "description": "A trigger that fires when the feature's source table changes: a DeltaTableSource's table, or an\nSdpSource's input_tables.", + "description": "A trigger that starts batch materialization when the feature's source table changes:\na DeltaTableSource's table, or an SdpSource's input_tables.", "properties": { "condition": { "description": "[Private Preview] Which source table updates trigger a materialization run. If not set, any source table update\ntriggers a run.", @@ -16321,6 +16376,18 @@ "[Private Preview]" ] }, + "postgres.OpenApiMode": { + "type": "string", + "description": "Controls how the Data API exposes the OpenAPI documentation endpoint. `OPEN_API_MODE_IGNORE_PRIVILEGES` serves the OpenAPI document without filtering it by the caller's privileges; `OPEN_API_MODE_DISABLED` turns the endpoint off.", + "enum": [ + "OPEN_API_MODE_IGNORE_PRIVILEGES", + "OPEN_API_MODE_DISABLED" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" + ] + }, "postgres.ProjectCustomTag": { "type": "object", "properties": { @@ -18535,6 +18602,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresCatalog" } }, + "resources.PostgresDataApi": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresDataApi" + } + }, "resources.PostgresDatabase": { "type": "object", "additionalProperties": {