From 24c12002a9dc2b32a336c2b47cdaf7e8bd43ffa6 Mon Sep 17 00:00:00 2001 From: Sankalp-Mittal Date: Thu, 3 Sep 2026 12:59:32 +0000 Subject: [PATCH 1/8] Emit x-databricks-launch-stage for all stamped launch stages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The schema generator only emitted x-databricks-launch-stage for private-preview fields, bundling two concerns in one branch: hiding private-preview fields from editor completions (DoNotSuggest) and emitting the machine-readable launch stage. Downstream codegen could therefore only distinguish private-preview from everything else. Split the two concerns: DoNotSuggest stays private-preview-only, while every field the contract stamps with a launch stage — GA, PUBLIC_BETA, PUBLIC_PREVIEW, PRIVATE_PREVIEW — now emits x-databricks-launch-stage so downstream tooling can read each field's stability. A field the contract leaves unstamped stays unmarked rather than defaulting to GA, via the new parseFieldLaunchStage (the enum path keeps dropping GA, unchanged). Regenerated jsonschema.json. pydabs codegen is unaffected (it branches only on PRIVATE_PREVIEW), so python/databricks/bundles is unchanged. Co-authored-by: Isaac --- bundle/internal/schema/annotations.go | 14 +- bundle/internal/schema/annotations_test.go | 25 +- bundle/internal/schema/parser.go | 14 +- bundle/internal/schema/parser_test.go | 23 + bundle/schema/jsonschema.json | 3279 +++++++++++++------- 5 files changed, 2260 insertions(+), 1095 deletions(-) diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index d3e105540dc..8f5568b8249 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -158,14 +158,16 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { s.DeprecationMessage = a.DeprecationMessage } - // Private-preview fields are hidden from completions and surfaced to - // downstream codegen via the launch stage: pydabs reads - // x-databricks-launch-stage from jsonschema.json to mark these fields - // experimental. Only the private-preview stage is emitted into the published - // schema — nothing consumes the others there; they surface only as the - // description prefix below and the per-value enumDescriptions labels. + // Private-preview fields are also hidden from editor completions. if a.LaunchStage == clijson.LaunchStagePrivatePreview { s.DoNotSuggest = true + } + + // Emit the launch stage for every field the contract stamps (GA included) so + // downstream codegen can read each field's stability, not just private + // preview. Fields the contract leaves unstamped stay empty. pydabs reads + // x-databricks-launch-stage from jsonschema.json. + if a.LaunchStage != "" { s.LaunchStage = string(a.LaunchStage) } diff --git a/bundle/internal/schema/annotations_test.go b/bundle/internal/schema/annotations_test.go index 7caaa0d29df..fde827de5ce 100644 --- a/bundle/internal/schema/annotations_test.go +++ b/bundle/internal/schema/annotations_test.go @@ -151,7 +151,7 @@ func TestStalePlaceholderDoesNotShadowMergedDescription(t *testing.T) { } func TestAssignAnnotationLaunchStage(t *testing.T) { - t.Run("public preview prefixes description and stays suggestible", func(t *testing.T) { + t.Run("public preview prefixes description, emits stage, stays suggestible", func(t *testing.T) { s := &jsonschema.Schema{} assignAnnotation(s, annotation.Descriptor{ Description: "Target QPS for the endpoint.", @@ -159,16 +159,35 @@ func TestAssignAnnotationLaunchStage(t *testing.T) { }) assert.Equal(t, "[Public Preview] Target QPS for the endpoint.", s.Description) assert.False(t, s.DoNotSuggest) - assert.Empty(t, s.LaunchStage) + assert.Equal(t, "PUBLIC_PREVIEW", s.LaunchStage) }) - t.Run("public beta prefixes description", func(t *testing.T) { + t.Run("public beta prefixes description and emits stage", func(t *testing.T) { s := &jsonschema.Schema{} assignAnnotation(s, annotation.Descriptor{ Description: "A field.", LaunchStage: "PUBLIC_BETA", }) assert.Equal(t, "[Beta] A field.", s.Description) + assert.Equal(t, "PUBLIC_BETA", s.LaunchStage) + }) + + t.Run("GA emits the stage without a description prefix", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "A field.", + LaunchStage: "GA", + }) + assert.Equal(t, "A field.", s.Description) + assert.False(t, s.DoNotSuggest) + assert.Equal(t, "GA", s.LaunchStage) + }) + + t.Run("unstamped field emits no stage", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{Description: "A field."}) + assert.Equal(t, "A field.", s.Description) + assert.Empty(t, s.LaunchStage) }) t.Run("private preview also hides from autocomplete", func(t *testing.T) { diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 315a1e82ada..7b29451244d 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -109,6 +109,18 @@ func normalizeLaunchStage(launchStage string) (clijson.LaunchStage, error) { return stage, nil } +// parseFieldLaunchStage validates a field's contract launch stage, keeping every +// explicit stage (GA included) so the generated schema records each field's +// stability, not just previews. An empty stage means the contract assigns none; +// it stays empty (unmarked) instead of defaulting to GA, so only fields the +// contract actually stamps carry a stage. +func parseFieldLaunchStage(launchStage string) (clijson.LaunchStage, error) { + if launchStage == "" { + return "", nil + } + return clijson.ParseLaunchStage(launchStage) +} + // notableEnumLaunchStages keeps only the enum values whose launch stage is // worth surfacing (i.e. not GA), so the annotation file isn't polluted with a // stage for every value of a GA enum. Returns nil when nothing remains. @@ -199,7 +211,7 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type) (annotation.File for k := range s.Properties { if refProp, ok := ref.Fields[k]; ok { - launchStage, fieldErr := normalizeLaunchStage(refProp.LaunchStage) + launchStage, fieldErr := parseFieldLaunchStage(refProp.LaunchStage) if fieldErr != nil { stageErr = errors.Join(stageErr, fmt.Errorf("%s.%s: %w", basePath, k, fieldErr)) } diff --git a/bundle/internal/schema/parser_test.go b/bundle/internal/schema/parser_test.go index 9b88228d89d..1e42591e53c 100644 --- a/bundle/internal/schema/parser_test.go +++ b/bundle/internal/schema/parser_test.go @@ -169,6 +169,29 @@ func TestNormalizeLaunchStageUnknown(t *testing.T) { assert.Error(t, err) } +func TestParseFieldLaunchStage(t *testing.T) { + tests := []struct { + input string + want clijson.LaunchStage + }{ + {"", ""}, // unstamped stays unstamped rather than defaulting to GA + {"GA", clijson.LaunchStageGA}, + {"PUBLIC_PREVIEW", clijson.LaunchStagePublicPreview}, + {"PUBLIC_BETA", clijson.LaunchStagePublicBeta}, + {"PRIVATE_PREVIEW", clijson.LaunchStagePrivatePreview}, + } + for _, tc := range tests { + got, err := parseFieldLaunchStage(tc.input) + require.NoError(t, err) + assert.Equal(t, tc.want, got) + } +} + +func TestParseFieldLaunchStageUnknown(t *testing.T) { + _, err := parseFieldLaunchStage("SOMETHING_ELSE") + assert.Error(t, err) +} + func TestNotableEnumLaunchStages(t *testing.T) { t.Run("drops GA, keeps preview values", func(t *testing.T) { got, err := notableEnumLaunchStages(map[string]string{ diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 6383b5ac2c5..318d9a5d51d 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -85,18 +85,22 @@ "properties": { "custom_description": { "description": "Custom description for the alert. support mustache template.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "custom_summary": { "description": "Custom summary for the alert. support mustache template.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "display_name": { "description": "The display name of the alert.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "evaluation": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation", + "x-databricks-launch-stage": "GA" }, "file_path": { "$ref": "#/$defs/string" @@ -113,7 +117,8 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -122,24 +127,29 @@ }, "query_text": { "description": "Text of the query to be run.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs", + "x-databricks-launch-stage": "GA" }, "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", "deprecated": true }, "schedule": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule", + "x-databricks-launch-stage": "GA" }, "warehouse_id": { "description": "ID of the SQL warehouse attached to the alert.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -164,7 +174,8 @@ "properties": { "budget_policy_id": { "description": "[Public Preview]", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "compute_max_instances": { "description": "[Private Preview] Maximum number of app instances. Must be set together with `compute_min_instances`.", @@ -179,14 +190,16 @@ "doNotSuggest": true }, "compute_size": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ComputeSize" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ComputeSize", + "x-databricks-launch-stage": "GA" }, "config": { "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.AppConfig" }, "description": { "description": "The description of the app.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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.", @@ -196,11 +209,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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitRepository", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitSource", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -208,7 +223,8 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -217,11 +233,13 @@ }, "resources": { "description": "Resources for the app.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.AppResource" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.AppResource", + "x-databricks-launch-stage": "GA" }, "source_code_path": { "description": "[Beta]", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "space": { "description": "[Private Preview] Name of the space this app belongs to.", @@ -231,15 +249,18 @@ }, "telemetry_export_destinations": { "description": "[Public Preview]", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "usage_policy_id": { "description": "[Public Preview]", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "user_api_scopes": { "description": "[Public Preview]", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -339,15 +360,18 @@ "properties": { "comment": { "description": "User-provided free-form text description.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "connection_name": { "description": "The name of the connection to an external data source.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "custom_max_retention_hours": { "description": "[Public Preview] Custom maximum retention period in hours for the catalog", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "grants": { "description": "The Unity Catalog privileges to grant to principals on this securable.", @@ -360,31 +384,38 @@ }, "managed_encryption_settings": { "description": "Control CMK encryption for managed catalog data", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionSettings" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionSettings", + "x-databricks-launch-stage": "GA" }, "name": { "description": "Name of catalog.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "options": { "description": "A map of key-value properties attached to the securable.", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "properties": { "description": "A map of key-value properties attached to the securable.", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "share_name": { "description": "The name of the share under the share provider.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "storage_root": { "description": "Storage root URL for managed tables within catalog.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -406,87 +437,108 @@ "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AutoScale", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", + "x-databricks-launch-stage": "GA" }, "dependency_mode": { "description": "[Beta] Controls dependency configuration for the cluster.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DependencyMode" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DependencyMode", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "docker_image": { "description": "Custom docker image BYOC", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "driver_node_type_flexibility": { "description": "Flexible node type configuration for the driver node.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "enable_local_disk_encryption": { "description": "Whether to enable LUKS on cluster VMs' local disks", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo", + "x-databricks-launch-stage": "GA" }, "instance_pool_id": { "description": "The optional ID of the instance pool to which the cluster belongs.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -494,11 +546,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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -507,51 +561,63 @@ }, "policy_id": { "description": "The ID of the cluster policy used to create the cluster if applicable.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine", + "x-databricks-launch-stage": "GA" }, "single_user_name": { "description": "Single user name if data_security_mode is `SINGLE_USER`", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "worker_node_type_flexibility": { "description": "Flexible node type configuration for worker nodes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", + "x-databricks-launch-stage": "GA" }, "workload_type": { "description": "Cluster Attributes showing for clusters workload types.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -603,26 +669,31 @@ "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" + "$ref": "#/$defs/interface", + "x-databricks-launch-stage": "GA" }, "description": { "description": "Additional human-readable description of the cluster policy.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.Library", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "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" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -631,11 +702,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" + "$ref": "#/$defs/interface", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -764,15 +837,18 @@ "properties": { "create_database_if_not_exists": { "description": "[Public Preview]", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "database_instance_name": { "description": "[Public Preview] The name of the DatabaseInstance housing the database.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "database_name": { "description": "[Public Preview] The name of the database (in an instance) associated with the catalog.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -780,7 +856,8 @@ }, "name": { "description": "[Public Preview] The name of the catalog in UC.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -804,19 +881,23 @@ "properties": { "capacity": { "description": "[Public Preview] The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.CustomTag", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "enable_pg_native_login": { "description": "[Public Preview] Whether to enable PG native password login on the instance. Defaults to false.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "enable_readable_secondaries": { "description": "[Public Preview] Whether to enable secondaries to serve read-only traffic. Defaults to false.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -824,15 +905,18 @@ }, "name": { "description": "[Public Preview] The name of the instance. This is the unique identifier for the instance.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -841,15 +925,18 @@ }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "stopped": { "description": "[Public Preview] Whether to stop the instance. An input only param, see effective_stopped for the output.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "usage_policy_id": { "description": "[Beta] The desired usage policy to associate with the instance.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -870,27 +957,33 @@ "properties": { "comment": { "description": "User-provided free-form text description.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "credential_name": { "description": "Name of the storage credential used with this location.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "encryption_details": { "description": "Encryption options that apply to clients connecting to cloud storage.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionDetails" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.EncryptionDetails", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.FileEventQueue", + "x-databricks-launch-stage": "GA" }, "grants": { "description": "The Unity Catalog privileges to grant to principals on this securable.", @@ -903,19 +996,23 @@ }, "name": { "description": "Name of the external location.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "read_only": { "description": "Indicates whether the external location is read-only.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "skip_validation": { "description": "Skips validation of the storage credential associated with the external location.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "url": { "description": "Path URL of the external location.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -988,35 +1085,43 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAwsAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAzureAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskSpec", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolGcpAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -1024,19 +1129,23 @@ }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "min_idle_instances": { "description": "Minimum number of idle instances to keep in the instance pool", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "node_type_flexibility": { "description": "Flexible node type configuration for the pool.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -1045,19 +1154,23 @@ }, "preloaded_docker_images": { "description": "Custom Docker Image BYOC", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.DockerImage" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -1113,35 +1226,43 @@ "properties": { "budget_policy_id": { "description": "[Public Preview] The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Continuous", + "x-databricks-launch-stage": "GA" }, "description": { "description": "An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobEmailNotifications", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobEnvironment", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GitSource", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobCluster", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -1149,19 +1270,23 @@ }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "name": { "description": "An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobNotificationSettings", + "x-databricks-launch-stage": "GA" }, "parameters": { "description": "Job-level parameter definitions", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobParameterDefinition" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobParameterDefinition", + "x-databricks-launch-stage": "GA" }, "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.", @@ -1171,7 +1296,8 @@ }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PerformanceTarget", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -1180,35 +1306,43 @@ }, "queue": { "description": "The queue settings of the job.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CronSchedule", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Task", + "x-databricks-launch-stage": "GA" }, "timeout_seconds": { "description": "An optional timeout applied to each run of this job. A value of `0` means no timeout.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TriggerSettings", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.TriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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.", @@ -1218,7 +1352,8 @@ }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -1286,11 +1421,13 @@ }, "job_id": { "description": "The ID of the job to be executed", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" }, "job_parameters": { "description": "Job-level parameters used in the run. for example `\"param\": \"overriding_val\"`", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed and when the run re-fires.", @@ -1306,15 +1443,18 @@ }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PerformanceTarget", + "x-databricks-launch-stage": "GA" }, "pipeline_params": { "description": "Controls whether the pipeline should perform a full refresh", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams", + "x-databricks-launch-stage": "GA" }, "python_named_params": { "description": "[Private Preview]", @@ -1334,7 +1474,8 @@ }, "queue": { "description": "The queue settings of the run.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.QueueSettings", + "x-databricks-launch-stage": "GA" }, "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.", @@ -1451,7 +1592,8 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -1459,7 +1601,8 @@ }, "name": { "description": "Experiment name.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -1468,7 +1611,8 @@ }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ExperimentTag", + "x-databricks-launch-stage": "GA" }, "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.", @@ -1529,7 +1673,8 @@ "properties": { "description": { "description": "Optional description for registered model.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -1537,7 +1682,8 @@ }, "name": { "description": "Register models under this name", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -1546,7 +1692,8 @@ }, "tags": { "description": "Additional metadata for registered model.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelTag" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/ml.ModelTag", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -1601,22 +1748,27 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayConfig", + "x-databricks-launch-stage": "GA" }, "budget_policy_id": { "description": "The budget policy to be applied to the serving endpoint.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "config": { "description": "The core config of the serving endpoint.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EndpointCoreConfigInput" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EndpointCoreConfigInput", + "x-databricks-launch-stage": "GA" }, "description": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "email_notifications": { "description": "Email notification settings.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EmailNotifications" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.EmailNotifications", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -1624,7 +1776,8 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -1634,20 +1787,24 @@ "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", "deprecated": true }, "route_optimized": { "description": "Enable route optimization for the serving endpoint.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.EndpointTag", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TelemetryConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -1735,11 +1892,13 @@ "properties": { "allow_duplicate_names": { "description": "If false, deployment will fail if name conflicts with that of another pipeline.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "budget_policy_id": { "description": "[Public Preview] Budget policy of this pipeline.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", @@ -1747,43 +1906,53 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "channel": { "description": "SDP Release Channel that specifies which version to use.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "clusters": { "description": "Cluster settings for this pipeline deployment.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster", + "x-databricks-launch-stage": "GA" }, "configuration": { "description": "String-String configuration for this pipeline execution.", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "continuous": { "description": "Whether the pipeline is continuous or triggered. This replaces `trigger`.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "development": { "description": "Whether the pipeline is in Development mode. Defaults to false.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "edition": { "description": "Pipeline product edition.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "environment": { "description": "[Public Preview] Environment specification for this pipeline used to install dependencies.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "event_log": { "description": "Event log configuration for this pipeline", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.EventLogSpec" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.EventLogSpec", + "x-databricks-launch-stage": "GA" }, "filters": { "description": "Filters on which Pipeline packages to include in the deployed graph.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Filters" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Filters", + "x-databricks-launch-stage": "GA" }, "gateway_definition": { "description": "[Private Preview] The definition of a gateway pipeline to support change data capture.", @@ -1793,15 +1962,18 @@ }, "id": { "description": "Unique identifier for this pipeline.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "libraries": { "description": "Libraries or code needed by this deployment.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -1809,15 +1981,18 @@ }, "name": { "description": "Friendly identifier for this pipeline.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "notifications": { "description": "List of notification settings for this pipeline.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -1826,7 +2001,8 @@ }, "photon": { "description": "Whether Photon is enabled for this pipeline.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "restart_window": { "description": "[Private Preview] Restart window of this pipeline.", @@ -1836,19 +2012,23 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RunAs", + "x-databricks-launch-stage": "GA" }, "schema": { "description": "The default schema (database) where tables are read from or published to.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "serverless": { "description": "Whether serverless compute is enabled for this pipeline.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "serverless_compute_id": { "description": "[Private Preview] Serverless compute ID specified by the user for serverless pipelines.", @@ -1858,21 +2038,25 @@ }, "storage": { "description": "DBFS root directory for storing checkpoints and tables.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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", "deprecated": true }, "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", "deprecated": true }, @@ -1936,11 +2120,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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -1948,7 +2134,8 @@ }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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`.", @@ -1964,19 +2151,23 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "source_branch_lsn": { "description": "[Beta] The Log Sequence Number (LSN) on the source branch from which this branch was created.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -1999,7 +2190,8 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "catalog_id": { "description": "The ID of the catalog in Unity Catalog; becomes the full resource name. For example, `my_catalog` becomes `catalogs/my_catalog`.", @@ -2007,7 +2199,8 @@ }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -2015,7 +2208,8 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -2049,7 +2243,8 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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.", @@ -2057,7 +2252,8 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -2080,15 +2276,18 @@ "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" + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "autoscaling_limit_min_cu": { "description": "[Beta] The minimum number of Compute Units. Minimum value is 0.5.", - "$ref": "#/$defs/float64" + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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`.", @@ -2096,11 +2295,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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointType", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -2108,7 +2309,8 @@ }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "parent": { "description": "The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}", @@ -2120,11 +2322,13 @@ }, "settings": { "description": "[Beta] A collection of settings for a compute endpoint.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -2147,31 +2351,38 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.ProjectCustomTag", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "default_endpoint_settings": { "description": "[Beta] A collection of settings for a compute endpoint.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.ProjectDefaultEndpointSettings" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.ProjectDefaultEndpointSettings", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "display_name": { "description": "[Beta] Human-readable project name. Length should be between 1 and 256 characters.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -2184,7 +2395,8 @@ }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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`.", @@ -2213,15 +2425,18 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleAttributes", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleAuthMethod", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.RoleIdentityType", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -2229,7 +2444,8 @@ }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.RoleMembershipRole", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "parent": { "description": "The branch where this role is created. Format projects/{project_id}/branches/{branch_id}.", @@ -2237,7 +2453,8 @@ }, "postgres_role": { "description": "[Beta] The name of the Postgres role. Required when creating the role.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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.", @@ -2273,15 +2490,18 @@ }, "branch": { "description": "[Beta] The full resource name the branch associated with the table.\n\nFormat: \"projects/{project_id}/branches/{branch_id}\".", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "extra_columns": { "description": "[Private Preview] Extra PostgreSQL-only columns to add to the synced table.", @@ -2295,23 +2515,28 @@ }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.NewPipelineSpec", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "primary_key_columns": { "description": "[Beta] Primary Key columns to be used for data insert/update in the destination.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "scheduling_policy": { "description": "[Beta] Scheduling policy of the underlying pipeline.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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.", @@ -2319,11 +2544,13 @@ }, "timeseries_key": { "description": "[Beta] Time series key to deduplicate (tie-break) rows with the same primary key.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecTypeOverride", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -2344,15 +2571,18 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "custom_metrics": { "description": "[Create:OPT Update:OPT] Custom metrics.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetric" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetric", + "x-databricks-launch-stage": "GA" }, "data_classification_config": { "description": "[Private Preview] [Create:OPT Update:OPT] Data classification related config.", @@ -2361,11 +2591,13 @@ "doNotSuggest": true }, "inference_log": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLog" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLog", + "x-databricks-launch-stage": "GA" }, "latest_monitor_failure_msg": { "description": "[Create:ERR Update:IGN] The latest error message for a monitor failure.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -2373,38 +2605,46 @@ }, "notifications": { "description": "[Create:OPT Update:OPT] Field for specifying notification settings.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorNotifications" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorNotifications", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "schedule": { "description": "[Create:OPT Update:OPT] The monitor schedule.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorCronSchedule" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorCronSchedule", + "x-databricks-launch-stage": "GA" }, "skip_builtin_dashboard": { "description": "Whether to skip creating a default dashboard summarizing data quality metrics.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "snapshot": { "description": "Configuration for monitoring snapshot tables.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorSnapshot" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorSnapshot", + "x-databricks-launch-stage": "GA" }, "table_name": { "$ref": "#/$defs/string" }, "time_series": { "description": "Configuration for monitoring time series tables.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorTimeSeries" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorTimeSeries", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -2428,27 +2668,33 @@ "properties": { "aliases": { "description": "List of aliases associated with the registered model", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RegisteredModelAlias" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.RegisteredModelAlias", + "x-databricks-launch-stage": "GA" }, "catalog_name": { "description": "The name of the catalog where the schema and the registered model reside", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "comment": { "description": "The comment attached to the registered model", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "created_at": { "description": "Creation timestamp of the registered model in milliseconds since the Unix epoch", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" }, "created_by": { "description": "The identifier of the user who created the registered model", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "full_name": { "description": "The three-level (fully qualified) name of the registered model", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "grants": { "description": "The Unity Catalog privileges to grant to principals on this securable.", @@ -2461,31 +2707,38 @@ }, "metastore_id": { "description": "The unique identifier of the metastore", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "name": { "description": "The name of the registered model", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "owner": { "description": "The identifier of the user who owns the registered model", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "schema_name": { "description": "The name of the schema where the registered model resides", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "storage_location": { "description": "The storage location on the cloud under which model version data files are stored", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "updated_at": { "description": "Last-update timestamp of the registered model in milliseconds since the Unix epoch", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" }, "updated_by": { "description": "The identifier of the user who updated the registered model last time", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -2504,15 +2757,18 @@ "properties": { "catalog_name": { "description": "Name of parent catalog.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "comment": { "description": "User-provided free-form text description.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "custom_max_retention_hours": { "description": "[Public Preview] Custom maximum retention period in hours for the schema.", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "grants": { "description": "The Unity Catalog privileges to grant to principals on this securable.", @@ -2525,15 +2781,18 @@ }, "name": { "description": "Name of schema, relative to parent catalog.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "properties": { "description": "A map of key-value properties attached to the securable.", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "storage_root": { "description": "Storage root URL for managed tables within schema.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -2557,15 +2816,18 @@ "properties": { "catalog_name": { "description": "The name of the catalog where the schema and the secret reside.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "comment": { "description": "User-provided free-form text description of the secret.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/time.Time", + "x-databricks-launch-stage": "GA" }, "grants": { "description": "The grants to apply on this secret.", @@ -2577,19 +2839,23 @@ }, "name": { "description": "The name of the secret, relative to its parent schema.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "schema_name": { "description": "The name of the schema where the secret resides.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -2700,31 +2966,38 @@ "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "channel": { "description": "Channel Details", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Channel" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Channel", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "creator_name": { "description": "warehouse creator name", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "enable_photon": { "description": "Configures whether the warehouse should use Photon optimized clusters.\n\nDefaults to true.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "enable_serverless_compute": { "description": "Configures whether the warehouse should use serverless compute", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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", "deprecated": true }, @@ -2734,15 +3007,18 @@ }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -2751,15 +3027,18 @@ }, "spot_instance_policy": { "description": "Configurations whether the endpoint should use spot instances.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SpotInstancePolicy" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SpotInstancePolicy", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.EndpointTags", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CreateWarehouseRequestWarehouseType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -2810,7 +3089,8 @@ "properties": { "database_instance_name": { "description": "[Public Preview] Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected).", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -2818,15 +3098,18 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "name": { "description": "[Public Preview] Full three-part (catalog, schema, table) name of the table.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "spec": { "description": "[Public Preview] Specification of a synced database table.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -2847,11 +3130,13 @@ "properties": { "budget_policy_id": { "description": "[Public Preview] The budget policy id to be applied", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "endpoint_type": { "description": "Type of endpoint", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -2859,7 +3144,8 @@ }, "name": { "description": "Name of the AI Search endpoint", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permissions": { "description": "The permissions to apply to this resource.", @@ -2868,7 +3154,8 @@ }, "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" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" }, "usage_policy_id": { "description": "[Private Preview] The usage policy id to be applied once we've migrated to usage policies", @@ -2925,15 +3212,18 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.DeltaSyncVectorIndexSpecRequest", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.DirectAccessVectorIndexSpec", + "x-databricks-launch-stage": "GA" }, "endpoint_name": { "description": "Name of the endpoint to be used for serving the index", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "grants": { "description": "The Unity Catalog privileges to grant to principals on this securable.", @@ -2942,11 +3232,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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType", + "x-databricks-launch-stage": "GA" }, "lifecycle": { "description": "Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.", @@ -2954,11 +3246,13 @@ }, "name": { "description": "Name of the index", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "primary_key": { "description": "Primary key of the index", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -2982,11 +3276,13 @@ "properties": { "catalog_name": { "description": "The name of the catalog where the schema and the volume are", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "comment": { "description": "The comment attached to the volume", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "grants": { "description": "The Unity Catalog privileges to grant to principals on this securable.", @@ -2999,19 +3295,23 @@ }, "name": { "description": "The name of the volume", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "schema_name": { "description": "The name of the schema where the volume is", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "storage_location": { "description": "The storage location on the cloud", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.VolumeType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -3909,27 +4209,33 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "deployment_id": { "description": "The unique id of the deployment.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.EnvVar", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.GitSource", + "x-databricks-launch-stage": "GA" }, "mode": { "description": "The mode of which the deployment will manage the source code.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentMode" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppDeploymentMode", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -3947,7 +4253,8 @@ "properties": { "source_code_path": { "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4024,42 +4331,54 @@ "type": "object", "properties": { "app": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceApp" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceApp", + "x-databricks-launch-stage": "GA" }, "database": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceDatabase" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceDatabase", + "x-databricks-launch-stage": "GA" }, "description": { "description": "Description of the App Resource.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "experiment": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceExperiment" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceExperiment", + "x-databricks-launch-stage": "GA" }, "genie_space": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceGenieSpace" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceGenieSpace", + "x-databricks-launch-stage": "GA" }, "job": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJob" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJob", + "x-databricks-launch-stage": "GA" }, "name": { "description": "Name of the App Resource.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "postgres": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourcePostgres" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourcePostgres", + "x-databricks-launch-stage": "GA" }, "secret": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecret" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecret", + "x-databricks-launch-stage": "GA" }, "serving_endpoint": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpoint" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpoint", + "x-databricks-launch-stage": "GA" }, "sql_warehouse": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouse" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouse", + "x-databricks-launch-stage": "GA" }, "uc_securable": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurable" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurable", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4079,10 +4398,12 @@ "type": "object", "properties": { "name": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceAppAppPermission" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceAppAppPermission", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4113,13 +4434,16 @@ "type": "object", "properties": { "database_name": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "instance_name": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceDatabaseDatabasePermission" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceDatabaseDatabasePermission", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4155,10 +4479,12 @@ "type": "object", "properties": { "experiment_id": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceExperimentExperimentPermission" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceExperimentExperimentPermission", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4195,13 +4521,16 @@ "type": "object", "properties": { "name": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceGenieSpaceGenieSpacePermission" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceGenieSpaceGenieSpacePermission", + "x-databricks-launch-stage": "GA" }, "space_id": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4241,11 +4570,13 @@ "properties": { "id": { "description": "Id of the job to grant permission on.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceJobJobPermission", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4283,13 +4614,16 @@ "type": "object", "properties": { "branch": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "database": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourcePostgresPostgresPermission" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourcePostgresPostgresPermission", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4321,15 +4655,18 @@ "properties": { "key": { "description": "Key of the secret to grant permission on.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSecretSecretPermission", + "x-databricks-launch-stage": "GA" }, "scope": { "description": "Scope of the secret to grant permission on.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4369,11 +4706,13 @@ "properties": { "name": { "description": "Name of the serving endpoint to grant permission on.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceServingEndpointServingEndpointPermission", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4411,11 +4750,13 @@ "properties": { "id": { "description": "Id of the SQL warehouse to grant permission on.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceSqlWarehouseSqlWarehousePermission", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4452,13 +4793,16 @@ "type": "object", "properties": { "permission": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurableUcSecurablePermission" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurableUcSecurablePermission", + "x-databricks-launch-stage": "GA" }, "securable_full_name": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "securable_type": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurableUcSecurableType" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.AppResourceUcSecurableUcSecurableType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4594,15 +4938,18 @@ "properties": { "name": { "description": "The name of the environment variable.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "value": { "description": "The value for the environment variable.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4621,19 +4968,23 @@ "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "provider": { "description": "Git provider. Case insensitive. Supported values: gitHub, gitHubEnterprise, bitbucketCloud,\nbitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition, awsCodeCommit.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "url": { "description": "URL of the Git repository.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4656,19 +5007,23 @@ "properties": { "branch": { "description": "Git branch to checkout.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "commit": { "description": "Git commit SHA to checkout.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "tag": { "description": "Git tag to checkout.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4687,7 +5042,8 @@ "properties": { "unity_catalog": { "description": "[Public Preview] Unity Catalog Destinations for OTEL telemetry export.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.UnityCatalog" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.UnityCatalog", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -4706,15 +5062,18 @@ "properties": { "logs_table": { "description": "[Public Preview] Unity Catalog table for OTEL logs.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "metrics_table": { "description": "[Public Preview] Unity Catalog table for OTEL metrics.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "traces_table": { "description": "[Public Preview] Unity Catalog table for OTEL traces (spans).", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -4737,7 +5096,8 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4754,13 +5114,16 @@ "type": "object", "properties": { "azure_cmk_access_connector_id": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "azure_cmk_managed_identity_id": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "azure_tenant_id": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4781,15 +5144,18 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4808,7 +5174,8 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.SseEncryptionDetails", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4827,15 +5194,18 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureEncryptionSettings", + "x-databricks-launch-stage": "GA" }, "azure_key_vault_key_id": { "description": "the AKV URL in Azure, null otherwise.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "customer_managed_key_id": { "description": "the CMK uuid in AWS and GCP, null otherwise.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4852,22 +5222,28 @@ "type": "object", "properties": { "managed_aqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage", + "x-databricks-launch-stage": "GA" }, "managed_pubsub": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", + "x-databricks-launch-stage": "GA" }, "managed_sqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", + "x-databricks-launch-stage": "GA" }, "provided_aqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AzureQueueStorage", + "x-databricks-launch-stage": "GA" }, "provided_pubsub": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.GcpPubsub", + "x-databricks-launch-stage": "GA" }, "provided_sqs": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.AwsSqsQueue", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4885,7 +5261,8 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4903,15 +5280,18 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorCronSchedulePauseStatus", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "timezone_id": { "description": "The timezone id (e.g., ``PST``) in which to evaluate the quartz expression.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -4971,7 +5351,8 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -4989,31 +5370,38 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "label_col": { "description": "Column for the label.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "model_id_col": { "description": "Column for the model identifier.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "prediction_col": { "description": "Column for the prediction.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "prediction_proba_col": { "description": "Column for prediction probabilities", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "problem_type": { "description": "Problem type the model aims to solve.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLogProblemType" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorInferenceLogProblemType", + "x-databricks-launch-stage": "GA" }, "timestamp_col": { "description": "Column for the timestamp.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -5054,23 +5442,28 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "name": { "description": "Name of the metric in the output tables.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "output_data_type": { "description": "The output type of the custom metric.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetricType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -5112,7 +5505,8 @@ "properties": { "on_failure": { "description": "Destinations to send notifications on failure/timeout.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", + "x-databricks-launch-stage": "GA" }, "on_new_classification_tag_detected": { "description": "[Private Preview] Destinations to send notifications on new classification tag detected.", @@ -5150,11 +5544,13 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "timestamp_col": { "description": "Column for the timestamp.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -5240,11 +5636,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "privileges": { "description": "The privileges assigned to the principal.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.Privilege" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.Privilege", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5262,27 +5660,33 @@ "properties": { "alias_name": { "description": "Name of the alias, e.g. 'champion' or 'latest_stable'", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "catalog_name": { "description": "The name of the catalog containing the model version", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "id": { "description": "The unique identifier of the alias", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "model_name": { "description": "The name of the parent registered model of the model version, relative to parent schema", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "schema_name": { "description": "The name of the schema containing the model version, relative to parent catalog", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "version_num": { "description": "Integer version number of the model version to which this alias points.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5301,11 +5705,13 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.SseEncryptionDetailsAlgorithm", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5355,7 +5761,8 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -5376,11 +5783,13 @@ "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5399,43 +5808,53 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAvailability", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.EbsVolumeType", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5471,23 +5890,28 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAvailability", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.LogAnalyticsInfo", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5522,11 +5946,13 @@ "properties": { "jobs": { "description": "With jobs set, the cluster can be used for jobs", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "notebooks": { "description": "With notebooks set, this cluster can be used for notebooks", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5545,15 +5971,18 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DbfsStorageInfo", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.S3StorageInfo", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.VolumesStorageInfo", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5604,143 +6033,178 @@ "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AutoScale", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode", + "x-databricks-launch-stage": "GA" }, "dependency_mode": { "description": "[Beta] Controls dependency configuration for the cluster.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DependencyMode" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DependencyMode", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "docker_image": { "description": "Custom docker image BYOC", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerImage", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "driver_node_type_flexibility": { "description": "Flexible node type configuration for the driver node.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "enable_local_disk_encryption": { "description": "Whether to enable LUKS on cluster VMs' local disks", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo", + "x-databricks-launch-stage": "GA" }, "instance_pool_id": { "description": "The optional ID of the instance pool to which the cluster belongs.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Kind", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "policy_id": { "description": "The ID of the cluster policy used to create the cluster if applicable.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RuntimeEngine", + "x-databricks-launch-stage": "GA" }, "single_user_name": { "description": "Single user name if data_security_mode is `SINGLE_USER`", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "worker_node_type_flexibility": { "description": "Flexible node type configuration for worker nodes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.NodeTypeFlexibility", + "x-databricks-launch-stage": "GA" }, "workload_type": { "description": "Cluster Attributes showing for clusters workload types.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkloadType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5815,7 +6279,8 @@ "properties": { "destination": { "description": "dbfs destination, e.g. `dbfs:/my/path`", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -5859,23 +6324,28 @@ "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "disk_iops": { "description": "The number of IOPS to provision for each attached disk.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "disk_throughput": { "description": "The disk throughput to provision for each attached disk, in MB per second.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5894,11 +6364,13 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskTypeAzureDiskVolumeType", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DiskTypeEbsVolumeType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5948,11 +6420,13 @@ "properties": { "password": { "description": "Password of the user", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "username": { "description": "Name of the user", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -5970,11 +6444,13 @@ "properties": { "basic_auth": { "description": "Basic auth with username and password", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerBasicAuth" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.DockerBasicAuth", + "x-databricks-launch-stage": "GA" }, "url": { "description": "URL of the docker image.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6009,25 +6485,30 @@ "properties": { "base_environment": { "description": "The base environment this environment is built on top of. A base environment defines the environment version and a\nlist of dependencies for serverless compute. The value can be a file path to a custom `env.yaml` file\n(e.g., `/Workspace/path/to/env.yaml`). Support for a Databricks-provided base environment ID\n(e.g., `workspace-base-environments/databricks_ai_v4`) and workspace base environment ID\n(e.g., `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) is in Beta.\nEither `environment_version` or `base_environment` can be provided.\nFor more information about Databricks-provided base environments, see the\n[list workspace base environments](:method:Environments/ListWorkspaceBaseEnvironments) API.\nFor more information, see", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "client": { "description": "Use `environment_version` instead.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "deprecated": true }, "dependencies": { "description": "List of pip dependencies, as supported by the version of pip in this environment.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6046,11 +6527,13 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability", + "x-databricks-launch-stage": "GA" }, "boot_disk_size": { "description": "Boot disk size in GB", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "confidential_compute_type": { "description": "[Private Preview] The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", @@ -6060,25 +6543,30 @@ }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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", "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6114,7 +6602,8 @@ "properties": { "destination": { "description": "GCS destination/URI, e.g. `gs://my-bucket/some-prefix`", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -6156,33 +6645,40 @@ "properties": { "abfss": { "description": "Contains the Azure Data Lake Storage destination path", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Adlsgen2Info" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Adlsgen2Info", + "x-databricks-launch-stage": "GA" }, "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", "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.LocalFileInfo", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcsStorageInfo", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.S3StorageInfo", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.VolumesStorageInfo", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.WorkspaceStorageInfo", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6201,19 +6697,23 @@ "properties": { "availability": { "description": "Availability type used for the spot nodes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAwsAttributesAvailability" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAwsAttributesAvailability", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6248,15 +6748,18 @@ "properties": { "availability": { "description": "Availability type used for the spot nodes.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAzureAttributesAvailability" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.InstancePoolAzureAttributesAvailability", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6291,15 +6794,18 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAvailability", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6348,33 +6854,40 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.RCranLibrary", + "x-databricks-launch-stage": "GA" }, "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", "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.PythonPyPiLibrary", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6392,7 +6905,8 @@ "properties": { "destination": { "description": "local file destination, e.g. `file:/my/local/file.sh`", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -6413,11 +6927,13 @@ "properties": { "log_analytics_primary_key": { "description": "The primary key for the Azure Log Analytics agent configuration", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "log_analytics_workspace_id": { "description": "The workspace ID for the Azure Log Analytics agent configuration", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6435,15 +6951,18 @@ "properties": { "coordinates": { "description": "Gradle-style maven coordinates. For example: \"org.jsoup:jsoup:1.7.2\".", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "repo": { "description": "Maven repo to install the Maven package from. If omitted, both Maven Central Repository\nand Spark Packages are searched.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -6465,7 +6984,8 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -6483,11 +7003,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "repo": { "description": "The repository where the package can be found. If not specified, the default pip index is\nused.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -6508,11 +7030,13 @@ "properties": { "package": { "description": "The name of the CRAN package to install.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "repo": { "description": "The repository where the package can be found. If not specified, the default CRAN repo is used.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -6550,31 +7074,38 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "enable_encryption": { "description": "(Optional) Flag to enable server side encryption, `false` by default.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -6596,7 +7127,8 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -6618,7 +7150,8 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClientsTypes", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -6640,7 +7173,8 @@ "properties": { "destination": { "description": "wsfs destination, e.g. `workspace:/cluster-init-scripts/setup-datadog.sh`", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -6676,11 +7210,13 @@ "properties": { "key": { "description": "[Beta] The key of the custom tag.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "value": { "description": "[Beta] The value of the custom tag.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -6699,15 +7235,18 @@ "properties": { "branch_time": { "description": "[Public Preview] Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "name": { "description": "[Public Preview] Name of the ref database instance.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -6765,15 +7304,18 @@ "properties": { "budget_policy_id": { "description": "[Beta] Budget policy to set on the newly created pipeline.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -6931,31 +7473,38 @@ }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "primary_key_columns": { "description": "[Public Preview] Primary Key columns to be used for data insert/update in the destination.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "scheduling_policy": { "description": "[Public Preview] Scheduling policy of the underlying pipeline.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPolicy" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPolicy", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_table_full_name": { "description": "[Public Preview] Three-part (catalog, schema, table) name of the source Delta table.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "timeseries_key": { "description": "[Public Preview] Time series key to deduplicate (tie-break) rows with the same primary key.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", @@ -7077,19 +7626,23 @@ "properties": { "continuous_update_status": { "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE\nor the SYNCED_UPDATING_PIPELINE_RESOURCES state.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioningStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpdateStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -7183,15 +7736,18 @@ }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.DeploymentSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", @@ -7201,11 +7757,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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -7227,19 +7785,23 @@ "properties": { "alert_id": { "description": "[Public Preview] The alert_id is the canonical identifier of the alert.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "warehouse_id": { "description": "[Public Preview] The warehouse_id identifies the warehouse settings used by the alert task.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -7258,11 +7820,13 @@ "properties": { "destination_id": { "description": "[Public Preview]", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "user_name": { "description": "[Public Preview] A valid workspace email address.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -7300,19 +7864,23 @@ "properties": { "clean_room_name": { "description": "The clean room that the notebook belongs to.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "notebook_base_parameters": { "description": "Base parameters to be used for the clean room notebook job.", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "notebook_name": { "description": "Name of the notebook being run.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -7334,7 +7902,8 @@ "properties": { "hardware_accelerator": { "description": "[Beta] Hardware accelerator configuration for Serverless GPU workloads.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -7388,11 +7957,13 @@ "properties": { "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpecAcceleratorType", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -7451,15 +8022,18 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ConditionTaskOp", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -7502,11 +8076,13 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskRetryMode", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -7525,7 +8101,8 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskRetryMode", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -7543,11 +8120,13 @@ "properties": { "pause_status": { "description": "Indicate whether this schedule is paused or not.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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.", @@ -7557,7 +8136,8 @@ }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -7580,11 +8160,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -7607,7 +8189,8 @@ "properties": { "dashboard_id": { "description": "The identifier of the dashboard to refresh.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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\\\"}\"`)", @@ -7617,11 +8200,13 @@ }, "subscription": { "description": "Optional: subscription configuration for sending the dashboard snapshot.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Subscription" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Subscription", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -7692,31 +8277,38 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -7738,15 +8330,18 @@ "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", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "compute": { "description": "[Public Preview] Compute resources allocated to each node in this deployment.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpec" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -7768,15 +8363,18 @@ "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -7797,15 +8395,18 @@ "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "inputs": { "description": "Array for task to iterate on. This can be a JSON string or a reference to\nan array parameter.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Task", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -7930,7 +8531,8 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -7949,26 +8551,32 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GitProvider", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "git_url": { "description": "URL of the repository to be cloned by this job.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "sparse_checkout": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparseCheckout" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparseCheckout", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -7990,11 +8598,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec", + "x-databricks-launch-stage": "GA" }, "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.", @@ -8021,11 +8631,13 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobDeploymentKind", + "x-databricks-launch-stage": "GA" }, "metadata_file_path": { "description": "Path of the file that contains deployment metadata.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -8087,28 +8699,34 @@ "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", "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -8126,11 +8744,13 @@ "properties": { "environment_key": { "description": "The key of an environment. It has to be unique within a job.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.Environment", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -8151,11 +8771,13 @@ "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -8173,11 +8795,13 @@ "properties": { "default": { "description": "Default value of the parameter.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "name": { "description": "The name of the defined parameter. May only contain alphanumeric characters, `_`, `-`, and `.`", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -8224,11 +8848,13 @@ }, "service_principal_name": { "description": "The application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -8344,15 +8970,18 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthOperator", + "x-databricks-launch-stage": "GA" }, "value": { "description": "Specifies the threshold value that the health metric should obey to satisfy the health rule.", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -8375,7 +9004,8 @@ "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRule", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -8461,19 +9091,23 @@ "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -8525,11 +9159,13 @@ "properties": { "interval": { "description": "The interval at which the trigger should run.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "unit": { "description": "The unit of time for the interval.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfigurationTimeUnit" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfigurationTimeUnit", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -8568,23 +9204,28 @@ "properties": { "full_refresh": { "description": "If true, triggers a full refresh on the spark declarative pipeline.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "full_refresh_selection": { "description": "[Beta] A list of tables to update with fullRefresh.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "refresh_selection": { "description": "[Beta] A list of tables to update without fullRefresh.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "reset_checkpoint_selection": { "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -8602,31 +9243,38 @@ "properties": { "full_refresh": { "description": "If true, triggers a full refresh on the spark declarative pipeline.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "full_refresh_selection": { "description": "[Beta] A list of tables to update with fullRefresh.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "parameters": { "description": "[Beta] Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "pipeline_id": { "description": "The full name of the pipeline task to execute.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "refresh_selection": { "description": "[Beta] A list of tables to update without fullRefresh.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "reset_checkpoint_selection": { "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -8647,23 +9295,28 @@ "properties": { "authentication_method": { "description": "[Public Preview] How the published Power BI model authenticates to Databricks", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "model_name": { "description": "[Public Preview] The name of the Power BI model", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "overwrite_existing": { "description": "[Public Preview] Whether to overwrite existing Power BI models", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "workspace_name": { "description": "[Public Preview] The name of the Power BI workspace of the model", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -8681,19 +9334,23 @@ "properties": { "catalog": { "description": "[Public Preview] The catalog name in Databricks", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "name": { "description": "[Public Preview] The table name in Databricks", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "schema": { "description": "[Public Preview] The schema name in Databricks", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "storage_mode": { "description": "[Public Preview] The Power BI storage mode of the table", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -8711,23 +9368,28 @@ "properties": { "connection_resource_name": { "description": "[Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "power_bi_model": { "description": "[Public Preview] The semantic model to update", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiModel" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiModel", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "refresh_after_update": { "description": "[Public Preview] Whether the model should be refreshed after the update", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "tables": { "description": "[Public Preview] The tables to be exported to Power BI", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "warehouse_id": { "description": "[Public Preview] The SQL warehouse ID to use as the Power BI data source", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -8797,19 +9459,23 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "package_name": { "description": "Name of the package to execute", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "parameters": { "description": "Command-line parameters passed to Python wheel task. Leave it empty if `named_parameters` is not null.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -8831,7 +9497,8 @@ "properties": { "enabled": { "description": "If true, enable queueing for the job. This is a required field.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -8896,11 +9563,13 @@ }, "job_id": { "description": "ID of the job to trigger.", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" }, "job_parameters": { "description": "Job-level parameters used to trigger the job.", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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.", @@ -8912,7 +9581,8 @@ }, "pipeline_params": { "description": "Controls whether the pipeline should perform a full refresh", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams", + "x-databricks-launch-stage": "GA" }, "python_named_params": { "description": "[Private Preview]", @@ -8986,20 +9656,24 @@ "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", "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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", "deprecated": true } @@ -9019,15 +9693,18 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9048,7 +9725,8 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9066,7 +9744,8 @@ "properties": { "patterns": { "description": "List of patterns to include for sparse checkout.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9140,27 +9819,33 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskAlert", + "x-databricks-launch-stage": "GA" }, "dashboard": { "description": "If dashboard, indicates that this job must refresh a SQL dashboard.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskDashboard" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskDashboard", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskFile", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "query": { "description": "If query, indicates that this job must execute a SQL query.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskQuery" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskQuery", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9181,15 +9866,18 @@ "properties": { "alert_id": { "description": "The canonical identifier of the SQL alert.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "pause_subscriptions": { "description": "If true, the alert notifications are not sent to subscribers.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "subscriptions": { "description": "If specified, alert notifications are sent to subscribers.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9210,19 +9898,23 @@ "properties": { "custom_subject": { "description": "Subject of the email sent to subscribers of this task.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "dashboard_id": { "description": "The canonical identifier of the SQL dashboard.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "pause_subscriptions": { "description": "If true, the dashboard snapshot is not taken, and emails are not sent to subscribers.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "subscriptions": { "description": "If specified, dashboard snapshots are sent to subscriptions.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SqlTaskSubscription", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9243,11 +9935,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9268,7 +9962,8 @@ "properties": { "query_id": { "description": "The canonical identifier of the SQL query.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9289,11 +9984,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9332,15 +10029,18 @@ "properties": { "custom_subject": { "description": "Optional: Allows users to specify a custom subject line on the email sent\nto subscribers.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "paused": { "description": "When true, the subscription will not send emails.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.SubscriptionSubscriber", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9358,11 +10058,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9380,19 +10082,23 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Condition", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9413,27 +10119,33 @@ "properties": { "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AiRuntimeTask", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CleanRoomsNotebookTask", + "x-databricks-launch-stage": "GA" }, "compute": { "description": "[Beta] Task level compute configuration.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ConditionTask", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DashboardTask", + "x-databricks-launch-stage": "GA" }, "dbt_cloud_task": { "description": "[Private Preview] Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", @@ -9451,39 +10163,48 @@ }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtTask", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.TaskDependency", + "x-databricks-launch-stage": "GA" }, "description": { "description": "An optional description for this task.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "disable_auto_optimization": { "description": "An option to disable auto optimization in serverless", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskEmailNotifications", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ForEachTask", + "x-databricks-launch-stage": "GA" }, "gen_ai_compute_task": { "description": "[Private Preview] DEPRECATED — use `AiRuntimeTask` for all new BYOT multi-node GPU\nworkloads (see ai_runtime_task.proto). `AiRuntimeTask` is the only\nsupported BYOT task type for new workloads; this proto is retained only\nfor AIR CLI (fka SGCLI) pywheel backwards compatibility and will be\nremoved once the pywheel → databricks-cli migration completes (post-\nPuPr).", @@ -9493,43 +10214,53 @@ }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthRules", + "x-databricks-launch-stage": "GA" }, "job_cluster_key": { "description": "If job_cluster_key, this task is executed reusing the cluster specified in `job.settings.job_clusters`.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.Library", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.NotebookTask", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TaskNotificationSettings", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "python_operator_task": { "description": "[Private Preview] The task runs a Python operator task.", @@ -9539,49 +10270,60 @@ }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonWheelTask", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.RunIf", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkJarTask", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SparkPythonTask", + "x-databricks-launch-stage": "GA" }, "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", "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.SqlTask", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "timeout_seconds": { "description": "An optional timeout applied to each run of this job task. A value of `0` means no timeout.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9602,11 +10344,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "task_key": { "description": "The name of the task this task depends on.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9628,28 +10372,34 @@ "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", "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9667,15 +10417,18 @@ "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9710,11 +10463,13 @@ "properties": { "continuous": { "description": "[Beta] Continuous trigger configuration.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ContinuousTriggerConfiguration" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ContinuousTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "file_arrival": { "description": "[Beta] File arrival trigger configuration.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "model": { "description": "[Private Preview] Model trigger configuration.", @@ -9724,15 +10479,18 @@ }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "schedule": { "description": "[Beta] Cron schedule trigger configuration.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CronTriggerConfiguration" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CronTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "sql_condition": { "description": "[Private Preview] Optional SQL condition that gates whether this trigger fires.", @@ -9742,7 +10500,8 @@ }, "table_update": { "description": "[Beta] Table update trigger configuration.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -9760,7 +10519,8 @@ "properties": { "file_arrival": { "description": "File arrival trigger settings.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration", + "x-databricks-launch-stage": "GA" }, "model": { "description": "[Private Preview]", @@ -9770,11 +10530,13 @@ }, "pause_status": { "description": "Whether this trigger is paused or not.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PauseStatus", + "x-databricks-launch-stage": "GA" }, "periodic": { "description": "Periodic trigger settings.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PeriodicTriggerConfiguration", + "x-databricks-launch-stage": "GA" }, "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.", @@ -9783,7 +10545,8 @@ "doNotSuggest": true }, "table_update": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TableUpdateTriggerConfiguration", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9800,7 +10563,8 @@ "type": "object", "properties": { "id": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -9821,23 +10585,28 @@ "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9873,11 +10642,13 @@ "properties": { "key": { "description": "The tag key.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "value": { "description": "The tag value.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -9917,11 +10688,13 @@ "properties": { "key": { "description": "The tag key.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "value": { "description": "The tag value.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -10038,11 +10811,13 @@ "properties": { "enabled": { "description": "[Public Preview] (Required, Mutable) Whether to enable auto full refresh or not.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -10064,7 +10839,8 @@ "properties": { "include_confluence_spaces": { "description": "[Public Preview] (Optional) Spaces to filter Confluence data on", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -10109,7 +10885,8 @@ }, "confluence_options": { "description": "[Public Preview] Confluence specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "gdrive_options": { "description": "[Private Preview]", @@ -10125,11 +10902,13 @@ }, "jira_options": { "description": "[Beta] Jira specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "kafka_options": { "description": "[Beta]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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.", @@ -10145,7 +10924,8 @@ }, "meta_ads_options": { "description": "[Beta] Meta Marketing (Meta Ads) specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "outlook_options": { "description": "[Private Preview] Outlook specific options for ingestion", @@ -10179,7 +10959,8 @@ }, "zendesk_support_options": { "description": "[Public Preview] Zendesk Support specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -10216,10 +10997,12 @@ "type": "object", "properties": { "quartz_cron_schedule": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "timezone_id": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -10238,15 +11021,18 @@ "properties": { "catalog_name": { "description": "[Public Preview] (Required, Immutable) The name of the catalog for the connector's staging storage location.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "schema_name": { "description": "[Public Preview] (Required, Immutable) The name of the schema for the connector's staging storage location.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -10314,15 +11100,18 @@ "properties": { "catalog": { "description": "The UC catalog the event log is published under.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "name": { "description": "The name the event log is published to in UC.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "schema": { "description": "The UC schema the event log is published under.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -10509,7 +11298,8 @@ "properties": { "path": { "description": "The absolute path of the source code.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -10527,11 +11317,13 @@ "properties": { "exclude": { "description": "Paths to exclude.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "include": { "description": "Paths to include.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -10706,15 +11498,18 @@ "properties": { "report": { "description": "[Public Preview] Select a specific source report.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "schema": { "description": "[Public Preview] Select all tables from a specific source schema.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "table": { "description": "[Public Preview] Select a specific source table.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -10789,27 +11584,33 @@ "properties": { "connection_name": { "description": "[Public Preview] The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with\nboth connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle,\n(connector_type = QUERY_BASED OR connector_type = CDC).\nIf connection name corresponds to database connectors like Oracle, and connector_type is not provided then\nconnector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion\npipeline.\nUnder certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed\nIngestion Pipeline with Gateway pipeline.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "netsuite_jar_path": { "description": "[Private Preview] Netsuite only configuration. When the field is set for a netsuite connector,\nthe jar stored in the field will be validated and added to the classpath of\npipeline's cluster.", @@ -10819,15 +11620,18 @@ }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_configurations": { "description": "[Public Preview] Top-level source configurations", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -10846,11 +11650,13 @@ "properties": { "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -10869,15 +11675,18 @@ "properties": { "cursor_columns": { "description": "[Public Preview] The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -11013,7 +11822,8 @@ "properties": { "include_jira_spaces": { "description": "[Beta] (Optional) Projects to filter Jira data on", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -11031,23 +11841,28 @@ "properties": { "as_variant": { "description": "[Beta] Parse the entire value as a single Variant column.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "schema": { "description": "[Beta] Inline schema string for JSON parsing (Spark DDL format).", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "schema_evolution_mode": { "description": "[Beta] (Optional) Schema evolution mode for schema inference.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "schema_file_path": { "description": "[Beta] Path to a schema file (.ddl).", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "schema_hints": { "description": "[Beta] (Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -11071,7 +11886,8 @@ }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "max_offsets_per_trigger": { "description": "[Private Preview] Internal option to control the maximum number of offsets to process per trigger.", @@ -11081,19 +11897,23 @@ }, "starting_offset": { "description": "[Beta] (Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "topics": { "description": "[Beta] Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -11289,30 +12109,35 @@ "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", "deprecated": true }, "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", "deprecated": true }, "action_report_time": { "description": "[Beta] (Optional, DEPRECATED — use custom_report_options.action_report_time) Timing used to report\naction statistics (impression, conversion, mixed, or lifetime)", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "deprecationMessage": "This field is deprecated", "deprecated": true }, "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", "deprecated": true }, "custom_insights_lookback_window": { "description": "[Beta] (Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API, shared by prebuilt and custom reports.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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.", @@ -11323,16 +12148,19 @@ "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", "deprecated": true }, "start_date": { "description": "[Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested, shared by prebuilt and custom reports.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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", "deprecated": true } @@ -11403,7 +12231,8 @@ "properties": { "path": { "description": "The absolute path of the source code.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -11421,11 +12250,13 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "email_recipients": { "description": "A list of email addresses notified when a configured alert is triggered.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -11444,15 +12275,18 @@ "properties": { "days_of_week": { "description": "[Public Preview] Days of week in which the window is allowed to happen\nIf not specified all days of the week will be used.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -11598,7 +12432,8 @@ "properties": { "include": { "description": "[Public Preview] The source code to include for pipelines", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -11616,79 +12451,98 @@ "properties": { "apply_policy_default_values": { "description": "Note: This field won't be persisted. Only API users will check this field.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineClusterAutoscale", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AwsAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.AzureAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ClusterLogConf", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "enable_local_disk_encryption": { "description": "Whether to enable local disk encryption for the cluster.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo", + "x-databricks-launch-stage": "GA" }, "instance_pool_id": { "description": "The optional ID of the instance pool to which the cluster belongs.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "policy_id": { "description": "The ID of the cluster policy used to create the cluster if applicable.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -11706,15 +12560,18 @@ "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelineClusterAutoscaleMode", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -11752,11 +12609,13 @@ "properties": { "kind": { "description": "The deployment method that manages the pipeline.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind", + "x-databricks-launch-stage": "GA" }, "metadata_file_path": { "description": "The path to the file containing metadata about the deployment.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -11777,11 +12636,13 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileLibrary", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "jar": { "description": "[Private Preview] URI of the jar to be installed. Currently only DBFS is supported.", @@ -11797,11 +12658,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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.NotebookLibrary", + "x-databricks-launch-stage": "GA" }, "whl": { "description": "URI of the whl to be installed.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA", "deprecationMessage": "This field is deprecated", "deprecated": true } @@ -11838,10 +12701,12 @@ "type": "object", "properties": { "cron": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.CronTrigger" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.CronTrigger", + "x-databricks-launch-stage": "GA" }, "manual": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -11860,11 +12725,13 @@ "properties": { "dependencies": { "description": "[Public Preview] List of pip dependencies, as supported by the version of pip in this environment.\nEach dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/\nAllowed dependency could be \u003crequirement specifier\u003e, \u003carchive url/path\u003e, \u003clocal project path\u003e(WSFS or Volumes in Databricks), \u003cvcs project url\u003e", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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\"`.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -11883,7 +12750,8 @@ "properties": { "slot_config": { "description": "[Public Preview] Optional. The Postgres slot configuration to use for logical replication", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -11902,11 +12770,13 @@ "properties": { "publication_name": { "description": "[Public Preview] The name of the publication to use for the Postgres source", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "slot_name": { "description": "[Public Preview] The name of the logical replication slot to use for the Postgres source", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -11984,23 +12854,28 @@ "properties": { "destination_catalog": { "description": "[Public Preview] Required. Destination catalog to store table.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_schema": { "description": "[Public Preview] Required. Destination schema to store table.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_table": { "description": "[Public Preview] Required. Destination table name. The pipeline fails if a table with that name already exists.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_url": { "description": "[Public Preview] Required. Report URL in the source system.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -12059,11 +12934,13 @@ "properties": { "service_principal_name": { "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "user_name": { "description": "The email of an active workspace user. Users can only set this field to their own email.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -12081,31 +12958,38 @@ "properties": { "connector_options": { "description": "[Public Preview] (Optional) Source Specific Connector Options", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_catalog": { "description": "[Public Preview] Required. Destination catalog to store tables.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionFanoutOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "source_catalog": { "description": "[Public Preview] The source catalog name. Might be optional depending on the type of source.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -12205,11 +13089,13 @@ "properties": { "postgres": { "description": "[Public Preview] Postgres-specific catalog-level configuration parameters", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_catalog": { "description": "[Public Preview] Source catalog name", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -12233,7 +13119,8 @@ }, "catalog": { "description": "[Public Preview] Catalog-level source configuration parameters", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "google_ads_config": { "description": "[Private Preview]", @@ -12257,35 +13144,43 @@ "properties": { "connector_options": { "description": "[Public Preview] (Optional) Source Specific Connector Options", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_catalog": { "description": "[Public Preview] Required. Destination catalog to store table.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_schema": { "description": "[Public Preview] Required. Destination schema to store table.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_catalog": { "description": "[Public Preview] Source catalog name. Might be optional depending on the type of source.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_schema": { "description": "[Public Preview] Schema name in the source database. Might be optional depending on the type of source.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -12308,35 +13203,43 @@ "properties": { "auto_full_refresh_policy": { "description": "[Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "primary_keys": { "description": "[Public Preview] The primary key of the table used to apply changes.", - "$ref": "#/$defs/slice/string" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "salesforce_include_formula_fields": { "description": "[Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", @@ -12346,19 +13249,23 @@ }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "workday_report_parameters": { "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report", @@ -12575,7 +13482,8 @@ "properties": { "format": { "description": "[Beta] Required: the wire format of the data.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "input_column": { "description": "[Private Preview] Optional input column to transform. When set, the transformer reads\nfrom this column instead of the default source column.", @@ -12585,7 +13493,8 @@ }, "json_options": { "description": "[Beta]", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "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.", @@ -12629,7 +13538,8 @@ "properties": { "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -12647,15 +13557,18 @@ "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -12678,7 +13591,8 @@ "properties": { "pg_settings": { "description": "A raw representation of Postgres settings.", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -12712,7 +13626,8 @@ "properties": { "budget_policy_id": { "description": "Budget policy to set on the newly created pipeline.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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.", @@ -12722,11 +13637,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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -12764,11 +13681,13 @@ "properties": { "key": { "description": "The key of the custom tag.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "value": { "description": "The value of the custom tag.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -12787,23 +13706,28 @@ "properties": { "autoscaling_limit_max_cu": { "description": "The maximum number of Compute Units. Minimum value is 0.5.", - "$ref": "#/$defs/float64" + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA" }, "autoscaling_limit_min_cu": { "description": "The minimum number of Compute Units. Minimum value is 0.5.", - "$ref": "#/$defs/float64" + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "pg_settings": { "description": "A raw representation of Postgres settings.", - "$ref": "#/$defs/map/string" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -12822,15 +13746,18 @@ "properties": { "bypassrls": { "description": "Grants the Postgres `BYPASSRLS` attribute, which lets the role bypass every row-level security policy.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "createdb": { "description": "Grants the Postgres `CREATEDB` attribute, which lets the role create databases.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "createrole": { "description": "Grants the Postgres `CREATEROLE` attribute, which lets the role create, alter, and drop other roles.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -12993,15 +13920,18 @@ "properties": { "column_name": { "description": "Name of the source column whose target PostgreSQL type should be overridden.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "pg_type": { "description": "PostgreSQL-specific target type to use for the column.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecPgSpecificType" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecPgSpecificType", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13023,11 +13953,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13045,23 +13977,28 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.FallbackConfig", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayInferenceTableConfig", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimit", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayUsageTrackingConfig", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13080,20 +14017,24 @@ "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", "deprecated": true }, "pii": { "description": "[Public Preview] Configuration for guardrail PII filter.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "safety": { "description": "[Public Preview] Indicates whether the safety filter is enabled.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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", "deprecated": true } @@ -13113,7 +14054,8 @@ "properties": { "behavior": { "description": "[Public Preview] Configuration for input guardrail filters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -13152,11 +14094,13 @@ "properties": { "input": { "description": "[Public Preview] Configuration for input guardrail filters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "output": { "description": "[Public Preview] Configuration for output guardrail filters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -13174,19 +14118,23 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "enabled": { "description": "Indicates whether the inference table is enabled.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13204,23 +14152,28 @@ "properties": { "calls": { "description": "Used to specify how many calls are allowed for a key within the renewal_period.", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitKey", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitRenewalPeriod", + "x-databricks-launch-stage": "GA" }, "tokens": { "description": "Used to specify how many tokens are allowed for a key within the renewal_period.", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13281,7 +14234,8 @@ "properties": { "enabled": { "description": "Whether to enable usage tracking.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13299,31 +14253,38 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "aws_region": { "description": "The AWS region to use. Bedrock has to be enabled there.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfigBedrockProvider", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13368,11 +14329,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13390,15 +14353,18 @@ "properties": { "key": { "description": "The name of the API key parameter used for authentication.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13420,19 +14386,23 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "enabled": { "description": "Indicates whether the inference table is enabled.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13450,11 +14420,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13472,15 +14444,18 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13499,15 +14474,18 @@ "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ApiKeyAuth", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.BearerTokenAuth", + "x-databricks-launch-stage": "GA" }, "custom_provider_url": { "description": "This is a field to provide the URL of the custom provider API.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13528,15 +14506,18 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "databricks_workspace_url": { "description": "The URL of the Databricks workspace containing the model serving endpoint\npointed to by this external model.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13557,11 +14538,13 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13580,20 +14563,24 @@ "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", "deprecated": true }, "served_entities": { "description": "The list of served entities under the serving endpoint config.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput", + "x-databricks-launch-stage": "GA" }, "traffic_config": { "description": "The traffic configuration associated with the serving endpoint config.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TrafficConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TrafficConfig", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13611,11 +14598,13 @@ "properties": { "key": { "description": "Key field for a serving endpoint tag.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "value": { "description": "Optional value field for a serving endpoint tag.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13636,51 +14625,63 @@ "properties": { "ai21labs_config": { "description": "AI21Labs Config. Only required if the provider is 'ai21labs'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfig", + "x-databricks-launch-stage": "GA" }, "anthropic_config": { "description": "Anthropic Config. Only required if the provider is 'anthropic'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AnthropicConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AnthropicConfig", + "x-databricks-launch-stage": "GA" }, "cohere_config": { "description": "Cohere Config. Only required if the provider is 'cohere'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.CohereConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.CohereConfig", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.CustomProviderConfig", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.DatabricksModelServingConfig", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.GoogleCloudVertexAiConfig", + "x-databricks-launch-stage": "GA" }, "name": { "description": "The name of the external model.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "openai_config": { "description": "OpenAI Config. Only required if the provider is 'openai'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.OpenAiConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.OpenAiConfig", + "x-databricks-launch-stage": "GA" }, "palm_config": { "description": "PaLM Config. Only required if the provider is 'palm'.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.PaLmConfig" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.PaLmConfig", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ExternalModelProvider", + "x-databricks-launch-stage": "GA" }, "task": { "description": "The task type of the external model.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13736,7 +14737,8 @@ "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" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13757,19 +14759,23 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "project_id": { "description": "This is the Google Cloud project id that the service account is\nassociated with.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13792,47 +14798,58 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "microsoft_entra_tenant_id": { "description": "This field is only required for Azure AD OpenAI and is the Microsoft\nEntra Tenant ID.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "openai_organization": { "description": "This is an optional field to specify the organization in OpenAI or Azure\nOpenAI.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13850,11 +14867,13 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -13872,15 +14891,18 @@ "properties": { "calls": { "description": "Used to specify how many calls are allowed for a key within the renewal_period.", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimitKey", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.RateLimitRenewalPeriod", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13937,15 +14959,18 @@ "type": "object", "properties": { "served_entity_name": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "served_model_name": { "description": "The name of the served model this route configures traffic for.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -13966,62 +14991,77 @@ "properties": { "burst_scaling_enabled": { "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "entity_version": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ExternalModel", + "x-databricks-launch-stage": "GA" }, "instance_profile_arn": { "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "max_provisioned_throughput": { "description": "The maximum tokens per second that the endpoint can scale up to.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "min_provisioned_throughput": { "description": "The minimum tokens per second that the endpoint can scale down to.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "provisioned_model_units": { "description": "[Public Preview] The number of model units provisioned.", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { "description": "Whether the compute resources for the served entity should scale down to zero.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServingModelWorkloadType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14039,57 +15079,71 @@ "properties": { "burst_scaling_enabled": { "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "GA" }, "instance_profile_arn": { "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "max_provisioned_throughput": { "description": "The maximum tokens per second that the endpoint can scale up to.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "min_provisioned_throughput": { "description": "The minimum tokens per second that the endpoint can scale down to.", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "model_name": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "model_version": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "provisioned_model_units": { "description": "[Public Preview] The number of model units provisioned.", - "$ref": "#/$defs/int64" + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { "description": "Whether the compute resources for the served entity should scale down to zero.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ServedModelInputWorkloadType", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -14197,19 +15251,23 @@ "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.TelemetryFeature", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.TelemetryInferenceTableConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.UnityCatalogTableNames", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -14252,7 +15310,8 @@ "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" + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -14270,7 +15329,8 @@ "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/serving.Route", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14288,19 +15348,23 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -14408,23 +15472,28 @@ "properties": { "comparison_operator": { "description": "Operator used for comparison in alert evaluation.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState", + "x-databricks-launch-stage": "GA" }, "notification": { "description": "User or Notification Destination to notify when alert is triggered.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Notification" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Notification", + "x-databricks-launch-stage": "GA" }, "source": { "description": "Source column from result to use to evaluate alert", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Operand", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -14446,14 +15515,17 @@ "properties": { "notify_on_ok": { "description": "Whether to notify alert subscribers when alert returns back to normal.", - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "subscriptions": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14470,10 +15542,12 @@ "type": "object", "properties": { "column": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", + "x-databricks-launch-stage": "GA" }, "value": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14491,13 +15565,16 @@ "properties": { "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation", + "x-databricks-launch-stage": "GA" }, "display": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "name": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -14517,13 +15594,16 @@ "type": "object", "properties": { "bool_value": { - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "GA" }, "double_value": { - "$ref": "#/$defs/float64" + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "GA" }, "string_value": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14541,11 +15621,13 @@ "properties": { "service_principal_name": { "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "user_name": { "description": "The email of an active workspace user. Can only set this field to their own email.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14562,10 +15644,12 @@ "type": "object", "properties": { "destination_id": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "user_email": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14583,10 +15667,12 @@ "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "name": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ChannelName" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ChannelName", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14658,15 +15744,18 @@ "properties": { "pause_status": { "description": "Indicate whether this schedule is paused or not.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, @@ -14687,10 +15776,12 @@ "type": "object", "properties": { "key": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "value": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14707,7 +15798,8 @@ "type": "object", "properties": { "custom_tags": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.EndpointTagPair" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.EndpointTagPair", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14776,31 +15868,38 @@ "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "GA" }, "embedding_source_columns": { "description": "The columns that contain the embedding source.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", + "x-databricks-launch-stage": "GA" }, "embedding_vector_columns": { "description": "The columns that contain the embedding vectors.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", + "x-databricks-launch-stage": "GA" }, "embedding_writeback_table": { "description": "[Optional] Name of the Delta table to sync the vector index contents and computed embeddings to.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.PipelineType", + "x-databricks-launch-stage": "GA" }, "source_table": { "description": "The name of the source table.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14818,15 +15917,18 @@ "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingSourceColumn", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/vectorsearch.EmbeddingVectorColumn", + "x-databricks-launch-stage": "GA" }, "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" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14844,15 +15946,18 @@ "properties": { "embedding_model_endpoint_name": { "description": "Name of the embedding model endpoint, used by default for both ingestion and querying.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "model_endpoint_name_for_query": { "description": "Name of the embedding model endpoint which, if specified, is used for querying (not ingestion).", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "name": { "description": "Name of the column", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14870,11 +15975,13 @@ "properties": { "embedding_dimension": { "description": "Dimension of the embedding vector", - "$ref": "#/$defs/int" + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "GA" }, "name": { "description": "Name of the column", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false @@ -14988,11 +16095,13 @@ "properties": { "dns_name": { "description": "The DNS of the KeyVault", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" }, "resource_id": { "description": "The resource id of the azure KeyVault that user wants to associate the scope with.", - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "GA" } }, "additionalProperties": false, From de7834e48c7aab03286ac6a958eaff2c020d10e5 Mon Sep 17 00:00:00 2001 From: Sankalp-Mittal Date: Thu, 3 Sep 2026 13:34:58 +0000 Subject: [PATCH 2/8] beautify comment --- bundle/internal/schema/annotations.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index 8f5568b8249..548cf5ae95f 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -158,7 +158,7 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { s.DeprecationMessage = a.DeprecationMessage } - // Private-preview fields are also hidden from editor completions. + // Private-preview fields are hidden from completions. if a.LaunchStage == clijson.LaunchStagePrivatePreview { s.DoNotSuggest = true } From bb7421fcd62fbccae59d40fb49cd60f94ee772f0 Mon Sep 17 00:00:00 2001 From: Sankalp-Mittal Date: Thu, 3 Sep 2026 13:35:05 +0000 Subject: [PATCH 3/8] reorder tests --- bundle/internal/schema/annotations_test.go | 53 ++++++++++++---------- 1 file changed, 28 insertions(+), 25 deletions(-) diff --git a/bundle/internal/schema/annotations_test.go b/bundle/internal/schema/annotations_test.go index fde827de5ce..bf63ec2222f 100644 --- a/bundle/internal/schema/annotations_test.go +++ b/bundle/internal/schema/annotations_test.go @@ -151,28 +151,40 @@ func TestStalePlaceholderDoesNotShadowMergedDescription(t *testing.T) { } func TestAssignAnnotationLaunchStage(t *testing.T) { - t.Run("public preview prefixes description, emits stage, stays suggestible", func(t *testing.T) { + t.Run("private preview prefixes description, emits stage, and hides from autocomplete", func(t *testing.T) { s := &jsonschema.Schema{} assignAnnotation(s, annotation.Descriptor{ - Description: "Target QPS for the endpoint.", - LaunchStage: "PUBLIC_PREVIEW", + Description: "Internal field.", + LaunchStage: "PRIVATE_PREVIEW", }) - assert.Equal(t, "[Public Preview] Target QPS for the endpoint.", s.Description) - assert.False(t, s.DoNotSuggest) - assert.Equal(t, "PUBLIC_PREVIEW", s.LaunchStage) + assert.Equal(t, "[Private Preview] Internal field.", s.Description) + assert.True(t, s.DoNotSuggest) + assert.Equal(t, "PRIVATE_PREVIEW", s.LaunchStage) }) - t.Run("public beta prefixes description and emits stage", func(t *testing.T) { + t.Run("public beta prefixes description, emits stage, and stays suggestible", func(t *testing.T) { s := &jsonschema.Schema{} assignAnnotation(s, annotation.Descriptor{ Description: "A field.", LaunchStage: "PUBLIC_BETA", }) assert.Equal(t, "[Beta] A field.", s.Description) + assert.False(t, s.DoNotSuggest) assert.Equal(t, "PUBLIC_BETA", s.LaunchStage) }) - t.Run("GA emits the stage without a description prefix", func(t *testing.T) { + t.Run("public preview prefixes description, emits stage, and stays suggestible", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "Target QPS for the endpoint.", + LaunchStage: "PUBLIC_PREVIEW", + }) + assert.Equal(t, "[Public Preview] Target QPS for the endpoint.", s.Description) + assert.False(t, s.DoNotSuggest) + assert.Equal(t, "PUBLIC_PREVIEW", s.LaunchStage) + }) + + t.Run("GA emits the stage without a description prefix and stays suggestible", func(t *testing.T) { s := &jsonschema.Schema{} assignAnnotation(s, annotation.Descriptor{ Description: "A field.", @@ -190,19 +202,6 @@ func TestAssignAnnotationLaunchStage(t *testing.T) { assert.Empty(t, s.LaunchStage) }) - t.Run("private preview also hides from autocomplete", func(t *testing.T) { - s := &jsonschema.Schema{} - // The private-preview stage both prefixes the description and hides the - // field; it is also emitted as x-databricks-launch-stage for pydabs. - assignAnnotation(s, annotation.Descriptor{ - Description: "Internal field.", - LaunchStage: "PRIVATE_PREVIEW", - }) - assert.Equal(t, "[Private Preview] Internal field.", s.Description) - assert.True(t, s.DoNotSuggest) - assert.Equal(t, "PRIVATE_PREVIEW", s.LaunchStage) - }) - t.Run("per-enum-value launch stages do not leak into description", func(t *testing.T) { s := &jsonschema.Schema{} assignAnnotation(s, annotation.Descriptor{ @@ -241,7 +240,8 @@ func TestBuildEnumDescriptions(t *testing.T) { enum := []any{"STORAGE_OPTIMIZED", "STANDARD"} t.Run("combines launch stage and description per value", func(t *testing.T) { - got := buildEnumDescriptions(enum, + got := buildEnumDescriptions( + enum, map[string]clijson.LaunchStage{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, map[string]string{ "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", @@ -255,7 +255,8 @@ func TestBuildEnumDescriptions(t *testing.T) { }) t.Run("launch stage only emits bracketed label", func(t *testing.T) { - got := buildEnumDescriptions(enum, + got := buildEnumDescriptions( + enum, map[string]clijson.LaunchStage{"STORAGE_OPTIMIZED": "PUBLIC_BETA"}, nil, ) @@ -263,7 +264,8 @@ func TestBuildEnumDescriptions(t *testing.T) { }) t.Run("description only is preserved verbatim", func(t *testing.T) { - got := buildEnumDescriptions(enum, + got := buildEnumDescriptions( + enum, nil, map[string]string{"STORAGE_OPTIMIZED": "Storage-optimized endpoint."}, ) @@ -272,7 +274,8 @@ func TestBuildEnumDescriptions(t *testing.T) { t.Run("returns nil when neither stage nor description has content", func(t *testing.T) { assert.Nil(t, buildEnumDescriptions(enum, nil, nil)) - assert.Nil(t, buildEnumDescriptions(enum, + assert.Nil(t, buildEnumDescriptions( + enum, map[string]clijson.LaunchStage{"STORAGE_OPTIMIZED": "GA"}, nil, )) From 48cc78559626f920ed515c285eedcca2e490c61d Mon Sep 17 00:00:00 2001 From: Sankalp-Mittal Date: Thu, 3 Sep 2026 14:49:03 +0000 Subject: [PATCH 4/8] Stamp launch stage on resource types, not just fields launchStageOverrides maps whole resource Go-types to a launch stage (the Postgres* resources at Public Beta), but OverrideLaunchStage was only applied to fields, so the type's own (self) schema stayed unstamped. Apply the override to the type descriptor too: the contract carries no type-level stage, so passing GA ("") returns the override when one is set, else "". The self descriptor already flows through assignAnnotation, so the type-level x-databricks-launch-stage now lands in jsonschema.json. This makes launchStageOverrides a per-resource stability registry that tags both the type and its fields. Regenerated jsonschema.json: the 7 Postgres* resource types gain the type-level PUBLIC_BETA marker (and the [Beta] description prefix, matching how their fields already render). pydabs codegen is unaffected. Co-authored-by: Isaac --- bundle/internal/schema/parser.go | 12 +++++++---- bundle/internal/schema/parser_test.go | 16 +++++++++++++++ bundle/schema/jsonschema.json | 29 +++++++++++++++++++-------- 3 files changed, 45 insertions(+), 12 deletions(-) diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 7b29451244d..491231aff33 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -192,17 +192,21 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type) (annotation.File } basePath := getPath(typ) - // The contract carries no schema-level launch stage, so a type is - // never itself marked private-preview — only its fields are (below). - // Enum schemas do carry per-value launch stages and descriptions. + // The contract carries no schema-level launch stage, so a type's stage + // comes only from the override map (launchStageOverrides), which stamps + // whole resources — e.g. Postgres* at Public Beta. Passing "" (GA, the + // least restrictive stage) returns the override when one is set for the + // type, else "". Enum schemas do carry per-value launch stages below. + typeStage := annotation.OverrideLaunchStage(basePath, "") enumLaunchStages, enumErr := notableEnumLaunchStages(ref.EnumLaunchStages) if enumErr != nil { stageErr = errors.Join(stageErr, fmt.Errorf("%s: %w", basePath, enumErr)) } enumDescriptions := nonEmptyEnumDescriptions(ref.EnumDescriptions) - if ref.Description != "" || ref.Enum != nil || enumLaunchStages != nil || enumDescriptions != nil { + if ref.Description != "" || ref.Enum != nil || enumLaunchStages != nil || enumDescriptions != nil || typeStage != "" { annotations.SetSelf(basePath, annotation.Descriptor{ Description: ref.Description, + LaunchStage: typeStage, Enum: enumValues(ref.Enum), EnumLaunchStages: enumLaunchStages, EnumDescriptions: enumDescriptions, diff --git a/bundle/internal/schema/parser_test.go b/bundle/internal/schema/parser_test.go index 1e42591e53c..aeafea785c2 100644 --- a/bundle/internal/schema/parser_test.go +++ b/bundle/internal/schema/parser_test.go @@ -146,6 +146,22 @@ func TestExtractAnnotationsOverridesLaunchStage(t *testing.T) { assert.Equal(t, clijson.LaunchStagePublicBeta, got.LaunchStage) } +// TestExtractAnnotationsStampsTypeLaunchStage asserts a resource type in the +// override map carries the override stage on its own (self) descriptor, so the +// type-level x-databricks-launch-stage is emitted, not just its fields'. The +// contract carries no type-level stage, so the override map is the only source. +func TestExtractAnnotationsStampsTypeLaunchStage(t *testing.T) { + p := newParser(map[string]*clijson.SchemaJSON{ + "postgres.RoleRoleSpec": {Fields: map[string]*clijson.SchemaFieldJSON{}}, + }) + + annotations, err := p.extractAnnotations(reflect.TypeFor[resources.PostgresRole]()) + require.NoError(t, err) + + self := annotations[getPath(reflect.TypeFor[resources.PostgresRole]())].Self + assert.Equal(t, clijson.LaunchStagePublicBeta, self.LaunchStage) +} + func TestNormalizeLaunchStage(t *testing.T) { tests := []struct { input string diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 318d9a5d51d..d7c8b988e71 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -2113,6 +2113,7 @@ "oneOf": [ { "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`.", @@ -2174,7 +2175,8 @@ "required": [ "branch_id", "parent" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, { "type": "string", @@ -2186,7 +2188,7 @@ "oneOf": [ { "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}.", @@ -2216,7 +2218,8 @@ "required": [ "catalog_id", "postgres_database" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, { "type": "string", @@ -2228,6 +2231,7 @@ "oneOf": [ { "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.", @@ -2261,7 +2265,8 @@ "database_id", "parent", "role" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, { "type": "string", @@ -2273,6 +2278,7 @@ "oneOf": [ { "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.", @@ -2336,7 +2342,8 @@ "endpoint_id", "parent", "endpoint_type" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, { "type": "string", @@ -2348,6 +2355,7 @@ "oneOf": [ { "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.", @@ -2410,7 +2418,8 @@ "additionalProperties": false, "required": [ "project_id" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, { "type": "string", @@ -2422,6 +2431,7 @@ "oneOf": [ { "type": "object", + "description": "[Beta]", "properties": { "attributes": { "description": "[Beta] The desired API-exposed Postgres role attributes to associate with the role.", @@ -2469,7 +2479,8 @@ "required": [ "role_id", "parent" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, { "type": "string", @@ -2481,6 +2492,7 @@ "oneOf": [ { "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.", @@ -2556,7 +2568,8 @@ "additionalProperties": false, "required": [ "synced_table_id" - ] + ], + "x-databricks-launch-stage": "PUBLIC_BETA" }, { "type": "string", From e11e6a4f4c0c8307b9de686e89e957d3f573d1d4 Mon Sep 17 00:00:00 2001 From: Sankalp-Mittal Date: Fri, 4 Sep 2026 08:55:51 +0000 Subject: [PATCH 5/8] convert to table test --- bundle/internal/schema/annotations_test.go | 64 ++++++++-------------- 1 file changed, 22 insertions(+), 42 deletions(-) diff --git a/bundle/internal/schema/annotations_test.go b/bundle/internal/schema/annotations_test.go index bf63ec2222f..3ad9bae6fd6 100644 --- a/bundle/internal/schema/annotations_test.go +++ b/bundle/internal/schema/annotations_test.go @@ -151,49 +151,29 @@ func TestStalePlaceholderDoesNotShadowMergedDescription(t *testing.T) { } func TestAssignAnnotationLaunchStage(t *testing.T) { - t.Run("private preview prefixes description, emits stage, and hides from autocomplete", func(t *testing.T) { - s := &jsonschema.Schema{} - assignAnnotation(s, annotation.Descriptor{ - Description: "Internal field.", - LaunchStage: "PRIVATE_PREVIEW", - }) - assert.Equal(t, "[Private Preview] Internal field.", s.Description) - assert.True(t, s.DoNotSuggest) - assert.Equal(t, "PRIVATE_PREVIEW", s.LaunchStage) - }) - - t.Run("public beta prefixes description, emits stage, and stays suggestible", func(t *testing.T) { - s := &jsonschema.Schema{} - assignAnnotation(s, annotation.Descriptor{ - Description: "A field.", - LaunchStage: "PUBLIC_BETA", - }) - assert.Equal(t, "[Beta] A field.", s.Description) - assert.False(t, s.DoNotSuggest) - assert.Equal(t, "PUBLIC_BETA", s.LaunchStage) - }) - - t.Run("public preview prefixes description, emits stage, and stays suggestible", func(t *testing.T) { - s := &jsonschema.Schema{} - assignAnnotation(s, annotation.Descriptor{ - Description: "Target QPS for the endpoint.", - LaunchStage: "PUBLIC_PREVIEW", - }) - assert.Equal(t, "[Public Preview] Target QPS for the endpoint.", s.Description) - assert.False(t, s.DoNotSuggest) - assert.Equal(t, "PUBLIC_PREVIEW", s.LaunchStage) - }) - - t.Run("GA emits the stage without a description prefix and stays suggestible", func(t *testing.T) { - s := &jsonschema.Schema{} - assignAnnotation(s, annotation.Descriptor{ - Description: "A field.", - LaunchStage: "GA", + // Each stamped stage emits x-databricks-launch-stage and prefixes the + // description with its tag (GA renders no tag); only private preview also + // hides the field from autocomplete. + tests := []struct { + name string + stage clijson.LaunchStage + wantDesc string + wantSuppress bool + }{ + {"private preview", clijson.LaunchStagePrivatePreview, "[Private Preview] A field.", true}, + {"public beta", clijson.LaunchStagePublicBeta, "[Beta] A field.", false}, + {"public preview", clijson.LaunchStagePublicPreview, "[Public Preview] A field.", false}, + {"GA", clijson.LaunchStageGA, "A field.", false}, + } + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{Description: "A field.", LaunchStage: tc.stage}) + assert.Equal(t, tc.wantDesc, s.Description) + assert.Equal(t, tc.wantSuppress, s.DoNotSuggest) + assert.Equal(t, string(tc.stage), s.LaunchStage) }) - assert.Equal(t, "A field.", s.Description) - assert.False(t, s.DoNotSuggest) - assert.Equal(t, "GA", s.LaunchStage) - }) + } t.Run("unstamped field emits no stage", func(t *testing.T) { s := &jsonschema.Schema{} From 994851a9896249e3544eab43ce7e75971d6673bd Mon Sep 17 00:00:00 2001 From: Sankalp-Mittal Date: Fri, 4 Sep 2026 09:06:45 +0000 Subject: [PATCH 6/8] shorten comments --- bundle/internal/schema/parser.go | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 491231aff33..0457fcb03c3 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -110,10 +110,7 @@ func normalizeLaunchStage(launchStage string) (clijson.LaunchStage, error) { } // parseFieldLaunchStage validates a field's contract launch stage, keeping every -// explicit stage (GA included) so the generated schema records each field's -// stability, not just previews. An empty stage means the contract assigns none; -// it stays empty (unmarked) instead of defaulting to GA, so only fields the -// contract actually stamps carry a stage. +// explicit stage. An empty stage means the contract assigns none; func parseFieldLaunchStage(launchStage string) (clijson.LaunchStage, error) { if launchStage == "" { return "", nil From 69ad76960da1c045fce7a288cb12d879ca9202c5 Mon Sep 17 00:00:00 2001 From: Sankalp-Mittal Date: Fri, 4 Sep 2026 09:48:26 +0000 Subject: [PATCH 7/8] change variable name and simplify comments --- bundle/internal/schema/parser.go | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 0457fcb03c3..c0190923b48 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -189,21 +189,17 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type) (annotation.File } basePath := getPath(typ) - // The contract carries no schema-level launch stage, so a type's stage - // comes only from the override map (launchStageOverrides), which stamps - // whole resources — e.g. Postgres* at Public Beta. Passing "" (GA, the - // least restrictive stage) returns the override when one is set for the - // type, else "". Enum schemas do carry per-value launch stages below. - typeStage := annotation.OverrideLaunchStage(basePath, "") + // A type carries no launch stage by default, so we set to GA, unless overridden. + typeLaunchStage := annotation.OverrideLaunchStage(basePath, "") enumLaunchStages, enumErr := notableEnumLaunchStages(ref.EnumLaunchStages) if enumErr != nil { stageErr = errors.Join(stageErr, fmt.Errorf("%s: %w", basePath, enumErr)) } enumDescriptions := nonEmptyEnumDescriptions(ref.EnumDescriptions) - if ref.Description != "" || ref.Enum != nil || enumLaunchStages != nil || enumDescriptions != nil || typeStage != "" { + if ref.Description != "" || ref.Enum != nil || enumLaunchStages != nil || enumDescriptions != nil || typeLaunchStage != "" { annotations.SetSelf(basePath, annotation.Descriptor{ Description: ref.Description, - LaunchStage: typeStage, + LaunchStage: typeLaunchStage, Enum: enumValues(ref.Enum), EnumLaunchStages: enumLaunchStages, EnumDescriptions: enumDescriptions, From 5510c9a67a19306202f1a5d51858619500638e2f Mon Sep 17 00:00:00 2001 From: Sankalp-Mittal Date: Fri, 4 Sep 2026 10:46:56 +0000 Subject: [PATCH 8/8] inline function --- bundle/internal/schema/parser.go | 21 +++++++++------------ bundle/internal/schema/parser_test.go | 23 ----------------------- 2 files changed, 9 insertions(+), 35 deletions(-) diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index c0190923b48..20b52298a0e 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -109,15 +109,6 @@ func normalizeLaunchStage(launchStage string) (clijson.LaunchStage, error) { return stage, nil } -// parseFieldLaunchStage validates a field's contract launch stage, keeping every -// explicit stage. An empty stage means the contract assigns none; -func parseFieldLaunchStage(launchStage string) (clijson.LaunchStage, error) { - if launchStage == "" { - return "", nil - } - return clijson.ParseLaunchStage(launchStage) -} - // notableEnumLaunchStages keeps only the enum values whose launch stage is // worth surfacing (i.e. not GA), so the annotation file isn't polluted with a // stage for every value of a GA enum. Returns nil when nothing remains. @@ -208,9 +199,15 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type) (annotation.File for k := range s.Properties { if refProp, ok := ref.Fields[k]; ok { - launchStage, fieldErr := parseFieldLaunchStage(refProp.LaunchStage) - if fieldErr != nil { - stageErr = errors.Join(stageErr, fmt.Errorf("%s.%s: %w", basePath, k, fieldErr)) + // An empty stage means the contract assigns none; keep it + // unmarked rather than letting ParseLaunchStage default it to GA. + var launchStage clijson.LaunchStage + if refProp.LaunchStage != "" { + stage, fieldErr := clijson.ParseLaunchStage(refProp.LaunchStage) + if fieldErr != nil { + stageErr = errors.Join(stageErr, fmt.Errorf("%s.%s: %w", basePath, k, fieldErr)) + } + launchStage = stage } // Apply custom launch stage override (e.g. keep resource in Beta despite API being GA) launchStage = annotation.OverrideLaunchStage(basePath, launchStage) diff --git a/bundle/internal/schema/parser_test.go b/bundle/internal/schema/parser_test.go index aeafea785c2..49f511a46e7 100644 --- a/bundle/internal/schema/parser_test.go +++ b/bundle/internal/schema/parser_test.go @@ -185,29 +185,6 @@ func TestNormalizeLaunchStageUnknown(t *testing.T) { assert.Error(t, err) } -func TestParseFieldLaunchStage(t *testing.T) { - tests := []struct { - input string - want clijson.LaunchStage - }{ - {"", ""}, // unstamped stays unstamped rather than defaulting to GA - {"GA", clijson.LaunchStageGA}, - {"PUBLIC_PREVIEW", clijson.LaunchStagePublicPreview}, - {"PUBLIC_BETA", clijson.LaunchStagePublicBeta}, - {"PRIVATE_PREVIEW", clijson.LaunchStagePrivatePreview}, - } - for _, tc := range tests { - got, err := parseFieldLaunchStage(tc.input) - require.NoError(t, err) - assert.Equal(t, tc.want, got) - } -} - -func TestParseFieldLaunchStageUnknown(t *testing.T) { - _, err := parseFieldLaunchStage("SOMETHING_ELSE") - assert.Error(t, err) -} - func TestNotableEnumLaunchStages(t *testing.T) { t.Run("drops GA, keeps preview values", func(t *testing.T) { got, err := notableEnumLaunchStages(map[string]string{