diff --git a/bundle/internal/annotation/descriptor.go b/bundle/internal/annotation/descriptor.go index be452a748b5..eb2f348524c 100644 --- a/bundle/internal/annotation/descriptor.go +++ b/bundle/internal/annotation/descriptor.go @@ -1,18 +1,19 @@ package annotation +import "github.com/databricks/cli/internal/clijson" + type Descriptor struct { - Description string `json:"description,omitempty"` - MarkdownDescription string `json:"markdown_description,omitempty"` - Title string `json:"title,omitempty"` - Default any `json:"default,omitempty"` - Enum []any `json:"enum,omitempty"` - MarkdownExamples string `json:"markdown_examples,omitempty"` - DeprecationMessage string `json:"deprecation_message,omitempty"` - Preview string `json:"x-databricks-preview,omitempty"` - LaunchStage string `json:"x-databricks-launch-stage,omitempty"` - EnumLaunchStages map[string]string `json:"x-databricks-enum-launch-stages,omitempty"` - EnumDescriptions map[string]string `json:"x-databricks-enum-descriptions,omitempty"` - OutputOnly *bool `json:"x-databricks-field-behaviors_output_only,omitempty"` + Description string `json:"description,omitempty"` + MarkdownDescription string `json:"markdown_description,omitempty"` + Title string `json:"title,omitempty"` + Default any `json:"default,omitempty"` + Enum []any `json:"enum,omitempty"` + MarkdownExamples string `json:"markdown_examples,omitempty"` + DeprecationMessage string `json:"deprecation_message,omitempty"` + LaunchStage clijson.LaunchStage `json:"x-databricks-launch-stage,omitempty"` + EnumLaunchStages map[string]clijson.LaunchStage `json:"x-databricks-enum-launch-stages,omitempty"` + EnumDescriptions map[string]string `json:"x-databricks-enum-descriptions,omitempty"` + OutputOnly *bool `json:"x-databricks-field-behaviors_output_only,omitempty"` } const Placeholder = "PLACEHOLDER" diff --git a/bundle/internal/annotation/preview.go b/bundle/internal/annotation/preview.go index 3b9973ebebb..381e915d581 100644 --- a/bundle/internal/annotation/preview.go +++ b/bundle/internal/annotation/preview.go @@ -1,15 +1,20 @@ package annotation +import "github.com/databricks/cli/internal/clijson" + +// previewTags maps each launch stage to the human-readable prefix prepended to +// a field's or enum value's description. clijson owns the closed set of stages; +// this map must cover every one (asserted by TestPreviewTagCoversAllStages). A +// stage mapping to "" (GA) renders no prefix. +var previewTags = map[clijson.LaunchStage]string{ + clijson.LaunchStageGA: "", + clijson.LaunchStagePublicPreview: "[Public Preview]", + clijson.LaunchStagePublicBeta: "[Beta]", + clijson.LaunchStagePrivatePreview: "[Private Preview]", +} + // PreviewTag returns the human-readable launch-stage prefix to prepend to a -// field's or enum value's description. Others are skipped. -func PreviewTag(launchStage string) string { - switch launchStage { - case "PRIVATE_PREVIEW": - return "[Private Preview]" - case "PUBLIC_BETA": - return "[Beta]" - case "PUBLIC_PREVIEW": - return "[Public Preview]" - } - return "" +// field's or enum value's description. GA and the empty stage return "". +func PreviewTag(stage clijson.LaunchStage) string { + return previewTags[stage] } diff --git a/bundle/internal/annotation/preview_test.go b/bundle/internal/annotation/preview_test.go index b6f5977cb4a..0f5f7b70387 100644 --- a/bundle/internal/annotation/preview_test.go +++ b/bundle/internal/annotation/preview_test.go @@ -4,18 +4,19 @@ import ( "testing" "github.com/databricks/cli/bundle/internal/annotation" + "github.com/databricks/cli/internal/clijson" "github.com/stretchr/testify/assert" ) func TestPreviewTag(t *testing.T) { tests := []struct { - launchStage string + launchStage clijson.LaunchStage want string }{ - {"PUBLIC_PREVIEW", "[Public Preview]"}, - {"PUBLIC_BETA", "[Beta]"}, - {"PRIVATE_PREVIEW", "[Private Preview]"}, - {"GA", ""}, + {clijson.LaunchStagePublicPreview, "[Public Preview]"}, + {clijson.LaunchStagePublicBeta, "[Beta]"}, + {clijson.LaunchStagePrivatePreview, "[Private Preview]"}, + {clijson.LaunchStageGA, ""}, {"", ""}, {"SOMETHING_ELSE", ""}, } @@ -23,3 +24,16 @@ func TestPreviewTag(t *testing.T) { assert.Equal(t, tc.want, annotation.PreviewTag(tc.launchStage)) } } + +// Every stage in the contract's closed set must have a tag entry, so a stage +// added to clijson without a tag here is caught rather than rendering blank. +// GA intentionally maps to the empty prefix; every other stage must be tagged. +func TestPreviewTagCoversAllStages(t *testing.T) { + for _, stage := range clijson.LaunchStages { + if stage == clijson.LaunchStageGA { + assert.Empty(t, annotation.PreviewTag(stage)) + continue + } + assert.NotEmpty(t, annotation.PreviewTag(stage), "stage %q has no preview tag", stage) + } +} diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index a9d3b2cfeaa..ee0bee52fef 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -13,6 +13,7 @@ import ( yaml3 "go.yaml.in/yaml/v3" "github.com/databricks/cli/bundle/internal/annotation" + "github.com/databricks/cli/internal/clijson" "github.com/databricks/cli/libs/dyn" "github.com/databricks/cli/libs/dyn/convert" "github.com/databricks/cli/libs/dyn/merge" @@ -134,16 +135,15 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { s.DeprecationMessage = a.DeprecationMessage } - // The raw launch stage is intentionally not emitted into the published - // schema — nothing consumes it there. It surfaces only as the description - // prefix below and the per-value enumDescriptions labels. - // x-databricks-preview does stay: the parser derives it from launch_stage - // (PRIVATE iff PRIVATE_PREVIEW), and pydabs reads it from jsonschema.json - // to mark fields experimental, so this branch also covers hiding - // private-preview fields. - if a.Preview == "PRIVATE" { + // 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. + if a.LaunchStage == clijson.LaunchStagePrivatePreview { s.DoNotSuggest = true - s.Preview = a.Preview + s.LaunchStage = string(a.LaunchStage) } if a.OutputOnly != nil && *a.OutputOnly { @@ -167,7 +167,7 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { // and the per-value description text. Returns nil when every entry would be // empty so the field is omitted from the schema. The enum slice is the same // one assigned to s.Enum, so the arrays stay index-aligned. -func buildEnumDescriptions(enum []any, launchStages, descriptions map[string]string) []string { +func buildEnumDescriptions(enum []any, launchStages map[string]clijson.LaunchStage, descriptions map[string]string) []string { if len(enum) == 0 || (len(launchStages) == 0 && len(descriptions) == 0) { return nil } diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml index a582548e560..ba6d1ab116f 100644 --- a/bundle/internal/schema/annotations_openapi.yml +++ b/bundle/internal/schema/annotations_openapi.yml @@ -116,15 +116,11 @@ github.com/databricks/cli/bundle/config/resources.App: Maximum number of app instances. Must be set together with `compute_min_instances`. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "compute_min_instances": "description": |- Minimum number of app instances. Must be set together with `compute_max_instances`. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "compute_size": {} "compute_status": "x-databricks-field-behaviors_output_only": |- @@ -211,8 +207,6 @@ github.com/databricks/cli/bundle/config/resources.App: Name of the space this app belongs to. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "telemetry_export_destinations": "x-databricks-launch-stage": |- PUBLIC_PREVIEW @@ -836,8 +830,6 @@ github.com/databricks/cli/bundle/config/resources.Job: See `effective_usage_policy_id` for the usage policy used by this workload. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "webhook_notifications": "description": |- A collection of system notification IDs to notify when runs of this job begin or complete. @@ -944,8 +936,6 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: The definition of a gateway pipeline to support change data capture. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "id": "description": |- Unique identifier for this pipeline. @@ -977,8 +967,6 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: Restart window of this pipeline. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "root_path": "description": |- Root path for this pipeline. @@ -1020,8 +1008,6 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: Usage policy of this pipeline. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/cli/bundle/config/resources.QualityMonitor: "assets_dir": "description": |- @@ -1040,8 +1026,6 @@ github.com/databricks/cli/bundle/config/resources.QualityMonitor: [Create:OPT Update:OPT] Data classification related config. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "inference_log": {} "latest_monitor_failure_msg": "description": |- @@ -1322,8 +1306,6 @@ github.com/databricks/cli/bundle/config/resources.VectorSearchEndpoint: The usage policy id to be applied once we've migrated to usage policies "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/cli/bundle/config/resources.VectorSearchIndex: "delta_sync_index_spec": "description": |- @@ -1693,8 +1675,6 @@ github.com/databricks/databricks-sdk-go/service/apps.ComputeStatus: true "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "message": "description": |- Compute status message @@ -1879,8 +1859,6 @@ github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificatio Whether to enable data classification. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination: "email_addresses": "description": |- @@ -1966,8 +1944,6 @@ github.com/databricks/databricks-sdk-go/service/catalog.MonitorNotifications: Destinations to send notifications on new classification tag detected. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/catalog.MonitorSnapshot: "_": "description": |- @@ -2684,8 +2660,6 @@ github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes: When not set, no confidential computing is applied. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "first_on_demand": "description": |- The first `first_on_demand` nodes of the cluster will be placed on on-demand instances. @@ -3613,22 +3587,16 @@ github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig: IDof the GPU pool to use. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "gpu_type": "description": |- GPU type. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "num_gpus": "description": |- Number of GPUs. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.Condition: "_": "enum": @@ -3703,8 +3671,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.DashboardTask: - For range and date range filters, provide a JSON object with `start` and `end` (e.g. `"{\"start\":\"1\",\"end\":\"10\"}"`) "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "subscription": "description": |- Optional: subscription configuration for sending the dashboard snapshot. @@ -3721,30 +3687,22 @@ github.com/databricks/databricks-sdk-go/service/jobs.DbtCloudTask: The resource name of the UC connection that authenticates the dbt Cloud for this task "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "dbt_cloud_job_id": "description": |- Id of the dbt Cloud job to be triggered "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask: "connection_resource_name": "description": |- The resource name of the UC connection that authenticates the dbt platform for this task "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "dbt_platform_job_id": "description": |- Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.DbtTask: "catalog": "description": |- @@ -3811,28 +3769,20 @@ github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask: Command launcher to run the actual script, e.g. bash, python etc. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "compute": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "dl_runtime_image": "description": |- Runtime image "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "mlflow_experiment_name": "description": |- Optional string containing the name of the MLflow experiment to log the run to. If name is not found, backend will create the mlflow experiment using the name. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "source": "description": |- Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository @@ -3841,30 +3791,22 @@ github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask: * `GIT`: Script is located in cloud Git provider. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "training_script_path": "description": |- The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "yaml_parameters": "description": |- Optional string containing model parameters passed to the training script in yaml format. If present, then the content in yaml_parameters_file_path will be ignored. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "yaml_parameters_file_path": "description": |- Optional path to a YAML file containing model parameters passed to the training script. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.GitProvider: "_": "enum": @@ -3924,8 +3866,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.GitSource: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "sparse_checkout": {} github.com/databricks/databricks-sdk-go/service/jobs.JobCluster: "job_cluster_key": @@ -3943,8 +3883,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobDeployment: Metadata service. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "kind": "description": |- The kind of deployment that manages the job. @@ -3961,8 +3899,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobDeployment: in the Deployment Metadata service. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.JobDeploymentKind: "_": "description": |- @@ -4070,8 +4006,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs: Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "service_principal_name": "description": |- Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role. @@ -4091,22 +4025,16 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobSource: * `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "import_from_git_branch": "description": |- Name of the branch which the job is imported from. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "job_config_path": "description": |- Path of the job YAML file that contains the job specification. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState: "_": "description": |- @@ -4197,31 +4125,23 @@ github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration: Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "condition": "description": |- The condition based on which to trigger a job run. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "min_time_between_triggers_seconds": "description": |- If set, the trigger starts a run only after the specified amount of time has passed since the last time the trigger fired. The minimum allowed value is 60 seconds. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "securable_name": "description": |- Name of the securable to monitor ("mycatalog.myschema.mymodel" in the case of model-level triggers, "mycatalog.myschema" in the case of schema-level triggers) or empty in the case of metastore-level triggers. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "wait_after_last_change_seconds": "description": |- If set, the trigger starts a run only after no model updates have occurred for the specified time @@ -4229,8 +4149,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration: minimum allowed value is 60 seconds. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition: "_": "enum": @@ -4450,27 +4368,19 @@ github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask: For example, `my_project.my_function` or `my_project.MyOperator`. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "parameters": "description": |- An ordered list of task parameters. TODO(JOBS-30885): Add limits for parameters. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter: "name": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "value": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.PythonWheelTask: "entry_point": "description": |- @@ -4536,8 +4446,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "jar_params": "description": |- A list of parameters for jobs with Spark JAR tasks, for example `"jar_params": ["john doe", "35"]`. @@ -4551,8 +4459,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "job_id": "description": |- ID of the job to trigger. @@ -4575,8 +4481,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "pipeline_params": "description": |- Controls whether the pipeline should perform a full refresh @@ -4585,8 +4489,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "python_params": "description": |- A list of parameters for jobs with Python tasks, for example `"python_params": ["john doe", "35"]`. @@ -4604,8 +4506,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "spark_submit_params": "description": |- A list of parameters for jobs with spark submit task, for example `"spark_submit_params": ["--class", "org.apache.spark.examples.SparkPi"]`. @@ -4623,8 +4523,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "sql_params": "description": |- A map from keys to values for jobs with SQL task, for example `"sql_params": {"name": "john doe", "age": "35"}`. The SQL alert task does not support custom parameters. @@ -4634,8 +4532,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.Source: "_": "description": |- @@ -4850,13 +4746,9 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "dbt_platform_task": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "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. @@ -4891,8 +4783,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "gen_ai_compute_task": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "health": "description": |- An optional set of health rules that can be defined for this job. @@ -4931,8 +4821,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: The task runs a Python operator task. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "python_wheel_task": "description": |- The task runs a Python wheel when the `python_wheel_task` field is present. @@ -5040,8 +4928,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.TriggerSettings: "model": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "pause_status": "description": |- Whether this trigger is paused or not. @@ -5152,8 +5038,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters: For Oracle databases, this maps to a service name. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: "_": "description": |- @@ -5166,8 +5050,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: "gdrive_options": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "google_ads_options": "description": |- Google Ads specific options for ingestion (object-level). @@ -5175,8 +5057,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: (source_configurations). "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "jira_options": "description": |- Jira specific options for ingestion @@ -5185,8 +5065,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: "kafka_options": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "meta_ads_options": "description": |- Meta Marketing (Meta Ads) specific options for ingestion @@ -5197,34 +5075,24 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: Outlook specific options for ingestion "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "sharepoint_options": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "smartsheet_options": "description": |- Smartsheet specific options for ingestion "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "tiktok_ads_options": "description": |- TikTok Ads specific options for ingestion "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "zendesk_support_options": "description": |- Zendesk Support specific options for ingestion "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType: "_": "description": |- @@ -5331,8 +5199,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter: Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "modified_before": "description": |- Include files with modification times occurring before the specified time. @@ -5340,87 +5206,61 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter: Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "path_filter": "description": |- Include files with file names matching the pattern Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions: "corrupt_record_column": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "file_filters": "description": |- Generic options "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "format": "description": |- required for TableSpec "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "format_options": "description": |- Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "ignore_corrupt_files": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "infer_column_types": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "reader_case_sensitive": "description": |- Column name case sensitivity https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "rescued_data_column": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "schema_evolution_mode": "description": |- Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "schema_hints": "description": |- Override inferred schema of specific columns Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "single_variant_column": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat: "_": "enum": @@ -5504,8 +5344,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig: the object-level value takes precedence over this top-level config. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: "_": "description": |- @@ -5518,8 +5356,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: If not specified, defaults to 30 days. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "manager_account_id": "description": |- (Optional at this level) Manager Account ID (also called MCC Account ID) used to list @@ -5527,8 +5363,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: Overrides GoogleAdsConfig.manager_account_id from source_configurations when set. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "sync_start_date": "description": |- (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. @@ -5536,26 +5370,18 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: If not specified, defaults to 2 years of historical data. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions: "entity_type": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "file_ingestion_options": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "url": "description": |- Google Drive URL. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType: "_": "enum": @@ -5596,29 +5422,21 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipeli This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "connection_name": "description": |- Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "connection_parameters": "description": |- Optional, Internal. Parameters required to establish an initial connection with the source. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "gateway_storage_catalog": "description": |- Required, Immutable. The name of the catalog for the gateway pipeline's storage location. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "gateway_storage_name": "description": |- Optional. The Unity Catalog-compatible name for the gateway storage location. @@ -5626,15 +5444,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipeli Spark Declarative Pipelines system will automatically create the storage location under the catalog and schema. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "gateway_storage_schema": "description": |- Required, Immutable. The name of the schema for the gateway pipelines's storage location. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition: "connection_name": "description": |- @@ -5689,8 +5503,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin pipeline's cluster. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "objects": "description": |- Required. Settings specifying tables to replicate and the destination for the replicated tables. @@ -5762,8 +5574,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "parameters": "description": |- Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), @@ -5775,8 +5585,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin } "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "report_parameters": "description": |- (Optional) Additional custom parameters for Workday Report @@ -5785,16 +5593,12 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue: "key": "description": |- Key for the report parameter, can be a column name or other metadata "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "value": "description": |- Value for the report parameter. @@ -5804,8 +5608,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin 3. date_sub(current_date(), x) -> subtract x (some non-negative integer) days from current date "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: "_": "enum": @@ -5905,36 +5707,26 @@ github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions Parse the entire value as a single Variant column. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "schema": "description": |- Inline schema string for JSON parsing (Spark DDL format). "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "schema_evolution_mode": "description": |- (Optional) Schema evolution mode for schema inference. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "schema_file_path": "description": |- Path to a schema file (.ddl). "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "schema_hints": "description": |- (Optional) Schema hints as a comma-separated string of "column_name type" pairs. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions: "client_config": "description": |- @@ -5943,55 +5735,41 @@ github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions: This is not supported and may break at any time. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "key_transformer": "description": |- (Optional) Transformer for the message key. If not specified, the key is left as raw bytes. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "max_offsets_per_trigger": "description": |- Internal option to control the maximum number of offsets to process per trigger. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "starting_offset": "description": |- (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest". "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "topic_pattern": "description": |- Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "topics": "description": |- Topics to subscribe to. Only one of topics or topic_pattern must be specified. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "value_transformer": "description": |- (Optional) Transformer for the message value. If not specified, the value is left as raw bytes. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.ManualTrigger: {} github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions: "_": @@ -6123,8 +5901,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: If not specified, defaults to ALL. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "body_format": "description": |- (Optional) Defines how the body_content column is populated. @@ -6132,8 +5908,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: TEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "folder_filter": "description": |- Deprecated. Use include_folders instead. @@ -6141,8 +5915,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "include_folders": "description": |- (Optional) Filter mail folders to include in the sync. @@ -6151,8 +5923,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Filter semantics: OR between different folders. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "include_mailboxes": "description": |- (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). @@ -6160,8 +5930,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Filter semantics: OR between different mailboxes. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "include_senders": "description": |- (Optional) Filter emails by sender address. Uses exact email match. @@ -6170,8 +5938,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Filter semantics: OR between different senders. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "include_subjects": "description": |- (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with @@ -6181,8 +5947,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Filter semantics: OR between different subjects. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "sender_filter": "description": |- Deprecated. Use include_senders instead. @@ -6190,8 +5954,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "start_date": "description": |- (Optional) Start date for the initial sync in YYYY-MM-DD format. @@ -6200,8 +5962,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: If not specified, complete history is ingested. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "subject_filter": "description": |- Deprecated. Use include_subjects instead. @@ -6209,8 +5969,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: This field is deprecated "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern: "include": "description": |- @@ -6351,8 +6109,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineDeployment: Metadata service. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "kind": "description": |- The deployment method that manages the pipeline. @@ -6366,8 +6122,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineDeployment: deployment in the Deployment Metadata service. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary: "file": "description": |- @@ -6384,15 +6138,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary: URI of the jar to be installed. Currently only DBFS is supported. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "maven": "description": |- Specification of a maven library to be installed. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "notebook": "description": |- The path to a notebook that defines a pipeline and is stored in the Databricks workspace. @@ -6443,8 +6193,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment: The value should be a string representing the environment version number, for example: `"4"`. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig: "_": "description": |- @@ -6501,24 +6249,18 @@ github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow: If not specified all days of the week will be used. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "start_hour": "description": |- An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. Continuous pipeline restart is triggered only within a five-hour window starting at this hour. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "time_zone_id": "description": |- Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.RunAs: "_": "description": |- @@ -6569,22 +6311,16 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions: If not specified, defaults to FILE. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "file_ingestion_options": "description": |- (Optional) File ingestion options for processing files. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "url": "description": |- Required. The SharePoint URL. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType: "_": "enum": @@ -6618,8 +6354,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions: If not specified, defaults to true. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig: "_": "description": |- @@ -6643,8 +6377,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig: "google_ads_config": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec: "connector_options": "description": |- @@ -6741,8 +6473,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "scd_type": "description": |- The SCD type to use to ingest the table. @@ -6758,8 +6488,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: (Optional) Additional custom parameters for Workday Report "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType: "_": "description": |- @@ -6788,8 +6516,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: If not specified, defaults to AUCTION_CAMPAIGN. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "dimensions": "description": |- (Optional) Dimensions to include in the report. @@ -6797,8 +6523,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: If not specified, defaults to campaign_id. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "lookback_window_days": "description": |- (Optional) Number of days to look back for report tables during incremental sync @@ -6806,8 +6530,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: If not specified, defaults to 7 days. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "metrics": "description": |- (Optional) Metrics to include in the report. @@ -6815,8 +6537,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: If not specified, defaults to basic metrics (spend, impressions, clicks, etc.) "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "query_lifetime": "description": |- (Optional) Whether to request lifetime metrics (all-time aggregated data). @@ -6824,16 +6544,12 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: If not specified, defaults to false. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "report_type": "description": |- (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "sync_start_date": "description": |- (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. @@ -6842,8 +6558,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: and 30 days for hourly reports. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel: "_": "description": |- @@ -6905,13 +6619,9 @@ github.com/databricks/databricks-sdk-go/service/pipelines.Transformer: Required: the wire format of the data. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE "json_options": "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat: "_": "enum": @@ -6934,8 +6644,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions: This determines the earliest date from which to sync historical data. "x-databricks-launch-stage": |- PRIVATE_PREVIEW - "x-databricks-preview": |- - PRIVATE github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec: "enable_readable_secondaries": "description": |- diff --git a/bundle/internal/schema/annotations_test.go b/bundle/internal/schema/annotations_test.go index a3dd0b7b8db..e4f3a7e851d 100644 --- a/bundle/internal/schema/annotations_test.go +++ b/bundle/internal/schema/annotations_test.go @@ -4,6 +4,7 @@ import ( "testing" "github.com/databricks/cli/bundle/internal/annotation" + "github.com/databricks/cli/internal/clijson" "github.com/databricks/cli/libs/jsonschema" "github.com/stretchr/testify/assert" ) @@ -60,6 +61,7 @@ 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) }) t.Run("public beta prefixes description", func(t *testing.T) { @@ -73,15 +75,15 @@ func TestAssignAnnotationLaunchStage(t *testing.T) { t.Run("private preview also hides from autocomplete", func(t *testing.T) { s := &jsonschema.Schema{} - // The parser pairs Preview "PRIVATE" with stage PRIVATE_PREVIEW; hiding - // rides on Preview, the prefix on the stage. + // 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.", - Preview: "PRIVATE", 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) { @@ -89,7 +91,7 @@ func TestAssignAnnotationLaunchStage(t *testing.T) { assignAnnotation(s, annotation.Descriptor{ Description: "Type of endpoint.", Enum: []any{"STORAGE_OPTIMIZED", "STANDARD"}, - EnumLaunchStages: map[string]string{ + EnumLaunchStages: map[string]clijson.LaunchStage{ "STORAGE_OPTIMIZED": "PUBLIC_PREVIEW", }, }) @@ -123,7 +125,7 @@ func TestBuildEnumDescriptions(t *testing.T) { t.Run("combines launch stage and description per value", func(t *testing.T) { got := buildEnumDescriptions(enum, - map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, + map[string]clijson.LaunchStage{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, map[string]string{ "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", "STANDARD": "Standard endpoint.", @@ -137,7 +139,7 @@ func TestBuildEnumDescriptions(t *testing.T) { t.Run("launch stage only emits bracketed label", func(t *testing.T) { got := buildEnumDescriptions(enum, - map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_BETA"}, + map[string]clijson.LaunchStage{"STORAGE_OPTIMIZED": "PUBLIC_BETA"}, nil, ) assert.Equal(t, []string{"[Beta]", ""}, got) @@ -154,7 +156,7 @@ 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, - map[string]string{"STORAGE_OPTIMIZED": "GA"}, + map[string]clijson.LaunchStage{"STORAGE_OPTIMIZED": "GA"}, nil, )) }) @@ -162,7 +164,7 @@ func TestBuildEnumDescriptions(t *testing.T) { t.Run("non-string enum entries leave an empty slot", func(t *testing.T) { got := buildEnumDescriptions( []any{"A", 42, "B"}, - map[string]string{"A": "PUBLIC_PREVIEW", "B": "PUBLIC_BETA"}, + map[string]clijson.LaunchStage{"A": "PUBLIC_PREVIEW", "B": "PUBLIC_BETA"}, nil, ) assert.Equal(t, []string{"[Public Preview]", "", "[Beta]"}, got) diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 904e7469b73..96cfcfbc6fe 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -2,6 +2,7 @@ package main import ( "bytes" + "errors" "fmt" "os" "path" @@ -87,44 +88,41 @@ func (p *annotationParser) findRef(typ reflect.Type) (*clijson.SchemaJSON, bool) return nil, false } -// previewFromLaunchStage maps a launch stage to the preview marker the bundle -// uses to hide a field or type from completions. cli.json no longer carries a -// separate preview flag — launch_stage is the single source of truth — so a -// private-preview stage is the only one that should not be suggested. Every -// other stage (GA, public preview, ...) yields an empty marker. -func previewFromLaunchStage(launchStage string) string { - if launchStage == "PRIVATE_PREVIEW" { - return "PRIVATE" +// normalizeLaunchStage validates the contract's launch stage and drops GA so it +// isn't persisted in the annotation file. GA is the implicit default for any +// field that isn't in a preview, so storing it would add a stage to thousands +// of entries for no benefit. It errors on any stage the CLI doesn't recognize +// so a stage introduced upstream fails codegen instead of silently rendering as +// GA (see clijson.ParseLaunchStage). +func normalizeLaunchStage(launchStage string) (clijson.LaunchStage, error) { + stage, err := clijson.ParseLaunchStage(launchStage) + if err != nil { + return "", err } - return "" -} - -// normalizeLaunchStage drops the GA stage so it isn't persisted in the -// annotation file. GA is the implicit default for any field that isn't in a -// preview, so storing it would add a stage to thousands of entries for no -// benefit. cli.json is already filtered at min-stage=PRIVATE_PREVIEW upstream, -// so the only other values are the preview stages, which we keep verbatim. -func normalizeLaunchStage(launchStage string) string { - if launchStage == "GA" { - return "" + if stage == clijson.LaunchStageGA { + return "", nil } - return launchStage + return stage, nil } // 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. -func notableEnumLaunchStages(stages map[string]string) map[string]string { - result := map[string]string{} +func notableEnumLaunchStages(stages map[string]string) (map[string]clijson.LaunchStage, error) { + result := map[string]clijson.LaunchStage{} for value, stage := range stages { - if ls := normalizeLaunchStage(stage); ls != "" { + ls, err := normalizeLaunchStage(stage) + if err != nil { + return nil, err + } + if ls != "" { result[value] = ls } } if len(result) == 0 { - return nil + return nil, nil } - return result + return result, nil } // nonEmptyEnumDescriptions drops blank per-value descriptions so the annotation @@ -184,6 +182,9 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over overrides = annotation.File{} } + // Launch-stage validation happens inside the transform callback below, which + // cannot return an error, so failures accumulate here and are returned after. + var stageErr error _, err = jsonschema.FromType(typ, []func(reflect.Type, jsonschema.Schema) jsonschema.Schema{ func(typ reflect.Type, s jsonschema.Schema) jsonschema.Schema { ref, ok := p.findRef(typ) @@ -197,7 +198,10 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over // 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. - enumLaunchStages := notableEnumLaunchStages(ref.EnumLaunchStages) + 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 { pkg[RootTypeKey] = annotation.Descriptor{ @@ -210,8 +214,10 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over for k := range s.Properties { if refProp, ok := ref.Fields[k]; ok { - preview := previewFromLaunchStage(refProp.LaunchStage) - launchStage := normalizeLaunchStage(refProp.LaunchStage) + launchStage, fieldErr := normalizeLaunchStage(refProp.LaunchStage) + if fieldErr != nil { + stageErr = errors.Join(stageErr, fmt.Errorf("%s.%s: %w", basePath, k, fieldErr)) + } description := refProp.Description @@ -226,7 +232,6 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over pkg[k] = annotation.Descriptor{ Description: description, - Preview: preview, LaunchStage: launchStage, DeprecationMessage: deprecationMessageFor(refProp.Deprecated), OutputOnly: isOutputOnly(refProp.Behaviors), @@ -244,6 +249,9 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over if err != nil { return err } + if stageErr != nil { + return stageErr + } err = saveYamlWithStyle(overridesPath, overrides) if err != nil { diff --git a/bundle/internal/schema/parser_test.go b/bundle/internal/schema/parser_test.go index a316d622475..1a0e86de5dd 100644 --- a/bundle/internal/schema/parser_test.go +++ b/bundle/internal/schema/parser_test.go @@ -3,40 +3,59 @@ package main import ( "testing" + "github.com/databricks/cli/internal/clijson" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestNormalizeLaunchStage(t *testing.T) { tests := []struct { input string - want string + want clijson.LaunchStage }{ {"GA", ""}, {"", ""}, - {"PUBLIC_PREVIEW", "PUBLIC_PREVIEW"}, - {"PUBLIC_BETA", "PUBLIC_BETA"}, - {"PRIVATE_PREVIEW", "PRIVATE_PREVIEW"}, + {"PUBLIC_PREVIEW", clijson.LaunchStagePublicPreview}, + {"PUBLIC_BETA", clijson.LaunchStagePublicBeta}, + {"PRIVATE_PREVIEW", clijson.LaunchStagePrivatePreview}, } for _, tc := range tests { - assert.Equal(t, tc.want, normalizeLaunchStage(tc.input)) + got, err := normalizeLaunchStage(tc.input) + require.NoError(t, err) + assert.Equal(t, tc.want, got) } } +func TestNormalizeLaunchStageUnknown(t *testing.T) { + _, err := normalizeLaunchStage("SOMETHING_ELSE") + assert.Error(t, err) +} + func TestNotableEnumLaunchStages(t *testing.T) { t.Run("drops GA, keeps preview values", func(t *testing.T) { - got := notableEnumLaunchStages(map[string]string{ + got, err := notableEnumLaunchStages(map[string]string{ "STORAGE_OPTIMIZED": "PUBLIC_PREVIEW", "STANDARD": "GA", }) - assert.Equal(t, map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, got) + require.NoError(t, err) + assert.Equal(t, map[string]clijson.LaunchStage{"STORAGE_OPTIMIZED": clijson.LaunchStagePublicPreview}, got) }) t.Run("returns nil when every value is GA", func(t *testing.T) { - assert.Nil(t, notableEnumLaunchStages(map[string]string{"STANDARD": "GA"})) + got, err := notableEnumLaunchStages(map[string]string{"STANDARD": "GA"}) + require.NoError(t, err) + assert.Nil(t, got) }) t.Run("returns nil for empty input", func(t *testing.T) { - assert.Nil(t, notableEnumLaunchStages(nil)) + got, err := notableEnumLaunchStages(nil) + require.NoError(t, err) + assert.Nil(t, got) + }) + + t.Run("errors on unknown stage", func(t *testing.T) { + _, err := notableEnumLaunchStages(map[string]string{"X": "SOMETHING_ELSE"}) + assert.Error(t, err) }) } diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index bea3f60546d..d7710c50f07 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -158,13 +158,13 @@ "compute_max_instances": { "description": "[Private Preview]", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "compute_min_instances": { "description": "[Private Preview]", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "compute_size": { @@ -206,7 +206,7 @@ "space": { "description": "[Private Preview] Name of the space this app belongs to.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "telemetry_export_destinations": { @@ -917,7 +917,7 @@ "usage_policy_id": { "description": "[Private Preview] The id of the user specified usage policy to use for this job.\nIf not specified, a default usage policy may be applied when creating or modifying the job.\nSee `effective_usage_policy_id` for the usage policy used by this workload.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "webhook_notifications": { @@ -1315,7 +1315,7 @@ "gateway_definition": { "description": "[Private Preview] The definition of a gateway pipeline to support change data capture.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "id": { @@ -1356,7 +1356,7 @@ "restart_window": { "description": "[Private Preview] Restart window of this pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "root_path": { @@ -1397,7 +1397,7 @@ "usage_policy_id": { "description": "[Private Preview] Usage policy of this pipeline.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -1750,7 +1750,7 @@ "data_classification_config": { "description": "[Private Preview] [Create:OPT Update:OPT] Data classification related config.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificationConfig", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "inference_log": { @@ -2181,7 +2181,7 @@ "usage_policy_id": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -4128,7 +4128,7 @@ "enabled": { "description": "[Private Preview] Whether to enable data classification.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -4293,7 +4293,7 @@ "on_new_classification_tag_detected": { "description": "[Private Preview] Destinations to send notifications on new classification tag detected.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -5081,7 +5081,7 @@ "confidential_compute_type": { "description": "[Private Preview] The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ConfidentialComputeType", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "first_on_demand": { @@ -6124,19 +6124,19 @@ "gpu_node_pool_id": { "description": "[Private Preview] IDof the GPU pool to use.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "gpu_type": { "description": "[Private Preview] GPU type.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "num_gpus": { "description": "[Private Preview] Number of GPUs.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6281,7 +6281,7 @@ "filters": { "description": "[Private Preview] Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key.\nThe parameter value format is dependent on the filter type:\n- For text and single-select filters, provide a single value (e.g. `\"value\"`)\n- For date and datetime filters, provide the value in ISO 8601 format (e.g. `\"2000-01-01T00:00:00\"`)\n- For multi-select filters, provide a JSON array of values (e.g. `\"[\\\"value1\\\",\\\"value2\\\"]\"`)\n- For range and date range filters, provide a JSON object with `start` and `end` (e.g. `\"{\\\"start\\\":\\\"1\\\",\\\"end\\\":\\\"10\\\"}\"`)", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "subscription": { @@ -6309,13 +6309,13 @@ "connection_resource_name": { "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt Cloud for this task", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "dbt_cloud_job_id": { "description": "[Private Preview] Id of the dbt Cloud job to be triggered", "$ref": "#/$defs/int64", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6335,13 +6335,13 @@ "connection_resource_name": { "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "dbt_platform_job_id": { "description": "[Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6480,49 +6480,49 @@ "command": { "description": "[Private Preview] Command launcher to run the actual script, e.g. bash, python etc.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "compute": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "dl_runtime_image": { "description": "[Private Preview] Runtime image", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "mlflow_experiment_name": { "description": "[Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "source": { "description": "[Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "training_script_path": { "description": "[Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "yaml_parameters": { "description": "[Private Preview] Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "yaml_parameters_file_path": { "description": "[Private Preview] Optional path to a YAML file containing model parameters passed to the training script.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -6849,7 +6849,7 @@ "group_name": { "description": "[Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "service_principal_name": { @@ -6878,19 +6878,19 @@ "dirty_state": { "description": "[Private Preview] Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "import_from_git_branch": { "description": "[Private Preview] Name of the branch which the job is imported from.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "job_config_path": { "description": "[Private Preview] Path of the job YAML file that contains the job specification.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -7022,31 +7022,31 @@ "aliases": { "description": "[Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "condition": { "description": "[Private Preview] The condition based on which to trigger a job run.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "min_time_between_triggers_seconds": { "description": "[Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "securable_name": { "description": "[Private Preview] Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "wait_after_last_change_seconds": { "description": "[Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -7373,13 +7373,13 @@ "main": { "description": "[Private Preview] Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "parameters": { "description": "[Private Preview] An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -7399,13 +7399,13 @@ "name": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "value": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -7508,7 +7508,7 @@ "dbt_commands": { "description": "[Private Preview] An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -7516,7 +7516,7 @@ "jar_params": { "description": "[Private Preview] A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -7532,7 +7532,7 @@ "notebook_params": { "description": "[Private Preview] A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -7544,7 +7544,7 @@ "python_named_params": { "description": "[Private Preview]", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -7552,7 +7552,7 @@ "python_params": { "description": "[Private Preview] A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -7560,7 +7560,7 @@ "spark_submit_params": { "description": "[Private Preview] A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -7568,7 +7568,7 @@ "sql_params": { "description": "[Private Preview] A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -8002,7 +8002,7 @@ "dbt_cloud_task": { "description": "[Private Preview] Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtCloudTask", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -8010,7 +8010,7 @@ "dbt_platform_task": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "dbt_task": { @@ -8052,7 +8052,7 @@ "gen_ai_compute_task": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "health": { @@ -8097,7 +8097,7 @@ "python_operator_task": { "description": "[Private Preview] The task runs a Python operator task.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "python_wheel_task": { @@ -8277,7 +8277,7 @@ "model": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "pause_status": { @@ -8489,7 +8489,7 @@ "source_catalog": { "description": "[Private Preview] Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8514,13 +8514,13 @@ "gdrive_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "google_ads_options": { "description": "[Private Preview] Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "jira_options": { @@ -8530,7 +8530,7 @@ "kafka_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "meta_ads_options": { @@ -8540,31 +8540,31 @@ "outlook_options": { "description": "[Private Preview] Outlook specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "sharepoint_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "smartsheet_options": { "description": "[Private Preview] Smartsheet specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "tiktok_ads_options": { "description": "[Private Preview] TikTok Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "zendesk_support_options": { "description": "[Private Preview] Zendesk Support specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8727,19 +8727,19 @@ "modified_after": { "description": "[Private Preview] Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "modified_before": { "description": "[Private Preview] Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "path_filter": { "description": "[Private Preview] Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8759,67 +8759,67 @@ "corrupt_record_column": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "file_filters": { "description": "[Private Preview] Generic options", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "format": { "description": "[Private Preview] required for TableSpec", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "format_options": { "description": "[Private Preview] Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "ignore_corrupt_files": { "description": "[Private Preview]", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "infer_column_types": { "description": "[Private Preview]", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "reader_case_sensitive": { "description": "[Private Preview] Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "rescued_data_column": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema_evolution_mode": { "description": "[Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema_hints": { "description": "[Private Preview] Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "single_variant_column": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8936,7 +8936,7 @@ "manager_account_id": { "description": "[Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8957,19 +8957,19 @@ "lookback_window_days": { "description": "[Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "manager_account_id": { "description": "[Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "sync_start_date": { "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8992,19 +8992,19 @@ "entity_type": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "file_ingestion_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "url": { "description": "[Private Preview] Google Drive URL.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9071,7 +9071,7 @@ "connection_id": { "description": "[Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -9079,31 +9079,31 @@ "connection_name": { "description": "[Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "connection_parameters": { "description": "[Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "gateway_storage_catalog": { "description": "[Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "gateway_storage_name": { "description": "[Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "gateway_storage_schema": { "description": "[Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9152,7 +9152,7 @@ "netsuite_jar_path": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "objects": { @@ -9211,7 +9211,7 @@ "incremental": { "description": "[Private Preview] (Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -9219,13 +9219,13 @@ "parameters": { "description": "[Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "report_parameters": { "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -9247,13 +9247,13 @@ "key": { "description": "[Private Preview] Key for the report parameter, can be a column name or other metadata", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "value": { "description": "[Private Preview] Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9347,31 +9347,31 @@ "as_variant": { "description": "[Private Preview] Parse the entire value as a single Variant column.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema": { "description": "[Private Preview] Inline schema string for JSON parsing (Spark DDL format).", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema_evolution_mode": { "description": "[Private Preview] (Optional) Schema evolution mode for schema inference.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema_file_path": { "description": "[Private Preview] Path to a schema file (.ddl).", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "schema_hints": { "description": "[Private Preview] (Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9391,43 +9391,43 @@ "client_config": { "description": "[Private Preview] Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "key_transformer": { "description": "[Private Preview] (Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "max_offsets_per_trigger": { "description": "[Private Preview] Internal option to control the maximum number of offsets to process per trigger.", "$ref": "#/$defs/int64", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "starting_offset": { "description": "[Private Preview] (Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "topic_pattern": { "description": "[Private Preview] Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "topics": { "description": "[Private Preview] Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "value_transformer": { "description": "[Private Preview] (Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9621,19 +9621,19 @@ "attachment_mode": { "description": "[Private Preview] (Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "body_format": { "description": "[Private Preview] (Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "folder_filter": { "description": "[Private Preview] Deprecated. Use include_folders instead.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -9641,31 +9641,31 @@ "include_folders": { "description": "[Private Preview] (Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "include_mailboxes": { "description": "[Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "include_senders": { "description": "[Private Preview] (Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "include_subjects": { "description": "[Private Preview] (Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "sender_filter": { "description": "[Private Preview] Deprecated. Use include_senders instead.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -9673,13 +9673,13 @@ "start_date": { "description": "[Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "subject_filter": { "description": "[Private Preview] Deprecated. Use include_subjects instead.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -9888,13 +9888,13 @@ "jar": { "description": "[Private Preview] URI of the jar to be installed. Currently only DBFS is supported.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "maven": { "description": "[Private Preview] Specification of a maven library to be installed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "notebook": { @@ -9967,7 +9967,7 @@ "environment_version": { "description": "[Private Preview] The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10068,19 +10068,19 @@ "days_of_week": { "description": "[Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "start_hour": { "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "time_zone_id": { "description": "[Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10169,19 +10169,19 @@ "entity_type": { "description": "[Private Preview] (Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "file_ingestion_options": { "description": "[Private Preview] (Optional) File ingestion options for processing files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "url": { "description": "[Private Preview] Required. The SharePoint URL.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10225,7 +10225,7 @@ "enforce_schema": { "description": "[Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10272,7 +10272,7 @@ "google_ads_config": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10367,7 +10367,7 @@ "salesforce_include_formula_fields": { "description": "[Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "scd_type": { @@ -10381,7 +10381,7 @@ "workday_report_parameters": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10424,43 +10424,43 @@ "data_level": { "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "dimensions": { "description": "[Private Preview] (Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "lookback_window_days": { "description": "[Private Preview] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "metrics": { "description": "[Private Preview] (Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "query_lifetime": { "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "report_type": { "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "sync_start_date": { "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10533,13 +10533,13 @@ "format": { "description": "[Private Preview] Required: the wire format of the data.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "json_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -10579,7 +10579,7 @@ "start_date": { "description": "[Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 972fdd11dba..40b80a1f6ef 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -106,14 +106,14 @@ "compute_max_instances": { "description": "[Private Preview]", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, "compute_min_instances": { "description": "[Private Preview]", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.2.0" }, @@ -166,7 +166,7 @@ "space": { "description": "[Private Preview] Name of the space this app belongs to.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.290.0" }, @@ -921,7 +921,7 @@ "usage_policy_id": { "description": "[Private Preview] The id of the user specified usage policy to use for this job.\nIf not specified, a default usage policy may be applied when creating or modifying the job.\nSee `effective_usage_policy_id` for the usage policy used by this workload.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.265.0" }, @@ -1289,7 +1289,7 @@ "gateway_definition": { "description": "[Private Preview] The definition of a gateway pipeline to support change data capture.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -1340,7 +1340,7 @@ "restart_window": { "description": "[Private Preview] Restart window of this pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.234.0" }, @@ -1390,7 +1390,7 @@ "usage_policy_id": { "description": "[Private Preview] Usage policy of this pipeline.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.276.0" } @@ -1738,7 +1738,7 @@ "data_classification_config": { "description": "[Private Preview] [Create:OPT Update:OPT] Data classification related config.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificationConfig", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -2172,7 +2172,7 @@ "usage_policy_id": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -3799,7 +3799,7 @@ "enabled": { "description": "[Private Preview] Whether to enable data classification.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" } @@ -3931,7 +3931,7 @@ "on_new_classification_tag_detected": { "description": "[Private Preview] Destinations to send notifications on new classification tag detected.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" } @@ -4592,7 +4592,7 @@ "confidential_compute_type": { "description": "[Private Preview] The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ConfidentialComputeType", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, @@ -5371,21 +5371,21 @@ "gpu_node_pool_id": { "description": "[Private Preview] IDof the GPU pool to use.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "gpu_type": { "description": "[Private Preview] GPU type.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "num_gpus": { "description": "[Private Preview] Number of GPUs.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" } @@ -5492,7 +5492,7 @@ "filters": { "description": "[Private Preview] Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key.\nThe parameter value format is dependent on the filter type:\n- For text and single-select filters, provide a single value (e.g. `\"value\"`)\n- For date and datetime filters, provide the value in ISO 8601 format (e.g. `\"2000-01-01T00:00:00\"`)\n- For multi-select filters, provide a JSON array of values (e.g. `\"[\\\"value1\\\",\\\"value2\\\"]\"`)\n- For range and date range filters, provide a JSON object with `start` and `end` (e.g. `\"{\\\"start\\\":\\\"1\\\",\\\"end\\\":\\\"10\\\"}\"`)", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.289.0" }, @@ -5515,14 +5515,14 @@ "connection_resource_name": { "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt Cloud for this task", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.256.0" }, "dbt_cloud_job_id": { "description": "[Private Preview] Id of the dbt Cloud job to be triggered", "$ref": "#/$defs/int64", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.256.0" } @@ -5535,14 +5535,14 @@ "connection_resource_name": { "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.257.0" }, "dbt_platform_job_id": { "description": "[Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.257.0" } @@ -5655,56 +5655,56 @@ "command": { "description": "[Private Preview] Command launcher to run the actual script, e.g. bash, python etc.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "compute": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "dl_runtime_image": { "description": "[Private Preview] Runtime image", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "mlflow_experiment_name": { "description": "[Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "source": { "description": "[Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "training_script_path": { "description": "[Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "yaml_parameters": { "description": "[Private Preview] Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "yaml_parameters_file_path": { "description": "[Private Preview] Optional path to a YAML file containing model parameters passed to the training script.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" } @@ -5951,7 +5951,7 @@ "group_name": { "description": "[Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.283.0" }, @@ -5975,21 +5975,21 @@ "dirty_state": { "description": "[Private Preview] Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "import_from_git_branch": { "description": "[Private Preview] Name of the branch which the job is imported from.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "job_config_path": { "description": "[Private Preview] Path of the job YAML file that contains the job specification.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" } @@ -6078,35 +6078,35 @@ "aliases": { "description": "[Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "condition": { "description": "[Private Preview] The condition based on which to trigger a job run.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "min_time_between_triggers_seconds": { "description": "[Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "securable_name": { "description": "[Private Preview] Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "wait_after_last_change_seconds": { "description": "[Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" } @@ -6370,14 +6370,14 @@ "main": { "description": "[Private Preview] Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "parameters": { "description": "[Private Preview] An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -6390,14 +6390,14 @@ "name": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "value": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -6474,7 +6474,7 @@ "dbt_commands": { "description": "[Private Preview] An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6483,7 +6483,7 @@ "jar_params": { "description": "[Private Preview] A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6502,7 +6502,7 @@ "notebook_params": { "description": "[Private Preview] A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6516,7 +6516,7 @@ "python_named_params": { "description": "[Private Preview]", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6525,7 +6525,7 @@ "python_params": { "description": "[Private Preview] A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6534,7 +6534,7 @@ "spark_submit_params": { "description": "[Private Preview] A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6543,7 +6543,7 @@ "sql_params": { "description": "[Private Preview] A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6891,7 +6891,7 @@ "dbt_cloud_task": { "description": "[Private Preview] Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtCloudTask", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.256.0", @@ -6900,7 +6900,7 @@ "dbt_platform_task": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.257.0" }, @@ -6952,7 +6952,7 @@ "gen_ai_compute_task": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, @@ -7008,7 +7008,7 @@ "python_operator_task": { "description": "[Private Preview] The task runs a Python operator task.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, @@ -7172,7 +7172,7 @@ "model": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, @@ -7329,7 +7329,7 @@ "source_catalog": { "description": "[Private Preview] Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" } @@ -7348,14 +7348,14 @@ "gdrive_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "google_ads_options": { "description": "[Private Preview] Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, @@ -7367,7 +7367,7 @@ "kafka_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, @@ -7379,35 +7379,35 @@ "outlook_options": { "description": "[Private Preview] Outlook specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "sharepoint_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "smartsheet_options": { "description": "[Private Preview] Smartsheet specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "tiktok_ads_options": { "description": "[Private Preview] TikTok Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "zendesk_support_options": { "description": "[Private Preview] Zendesk Support specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -7523,21 +7523,21 @@ "modified_after": { "description": "[Private Preview] Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "modified_before": { "description": "[Private Preview] Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "path_filter": { "description": "[Private Preview] Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -7550,77 +7550,77 @@ "corrupt_record_column": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_filters": { "description": "[Private Preview] Generic options", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format": { "description": "[Private Preview] required for TableSpec", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format_options": { "description": "[Private Preview] Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "ignore_corrupt_files": { "description": "[Private Preview]", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "infer_column_types": { "description": "[Private Preview]", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "reader_case_sensitive": { "description": "[Private Preview] Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "rescued_data_column": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "schema_evolution_mode": { "description": "[Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "schema_hints": { "description": "[Private Preview] Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "single_variant_column": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -7701,7 +7701,7 @@ "manager_account_id": { "description": "[Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -7715,21 +7715,21 @@ "lookback_window_days": { "description": "[Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "manager_account_id": { "description": "[Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "sync_start_date": { "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -7745,21 +7745,21 @@ "entity_type": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_ingestion_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "url": { "description": "[Private Preview] Google Drive URL.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -7806,7 +7806,7 @@ "connection_id": { "description": "[Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -7815,35 +7815,35 @@ "connection_name": { "description": "[Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.234.0" }, "connection_parameters": { "description": "[Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "gateway_storage_catalog": { "description": "[Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "gateway_storage_name": { "description": "[Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "gateway_storage_schema": { "description": "[Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" } @@ -7891,7 +7891,7 @@ "netsuite_jar_path": { "description": "[Private Preview]", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" }, @@ -7941,7 +7941,7 @@ "incremental": { "description": "[Private Preview] (Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.271.0", @@ -7950,14 +7950,14 @@ "parameters": { "description": "[Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" }, "report_parameters": { "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.271.0", @@ -7972,14 +7972,14 @@ "key": { "description": "[Private Preview] Key for the report parameter, can be a column name or other metadata", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" }, "value": { "description": "[Private Preview] Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" } @@ -8051,35 +8051,35 @@ "as_variant": { "description": "[Private Preview] Parse the entire value as a single Variant column.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema": { "description": "[Private Preview] Inline schema string for JSON parsing (Spark DDL format).", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_evolution_mode": { "description": "[Private Preview] (Optional) Schema evolution mode for schema inference.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_file_path": { "description": "[Private Preview] Path to a schema file (.ddl).", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_hints": { "description": "[Private Preview] (Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -8092,49 +8092,49 @@ "client_config": { "description": "[Private Preview] Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", "$ref": "#/$defs/map/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "key_transformer": { "description": "[Private Preview] (Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "max_offsets_per_trigger": { "description": "[Private Preview] Internal option to control the maximum number of offsets to process per trigger.", "$ref": "#/$defs/int64", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "starting_offset": { "description": "[Private Preview] (Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "topic_pattern": { "description": "[Private Preview] Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "topics": { "description": "[Private Preview] Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "value_transformer": { "description": "[Private Preview] (Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -8279,21 +8279,21 @@ "attachment_mode": { "description": "[Private Preview] (Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "body_format": { "description": "[Private Preview] (Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "folder_filter": { "description": "[Private Preview] Deprecated. Use include_folders instead.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.299.2", @@ -8302,35 +8302,35 @@ "include_folders": { "description": "[Private Preview] (Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_mailboxes": { "description": "[Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_senders": { "description": "[Private Preview] (Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_subjects": { "description": "[Private Preview] (Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "sender_filter": { "description": "[Private Preview] Deprecated. Use include_senders instead.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.299.2", @@ -8339,14 +8339,14 @@ "start_date": { "description": "[Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "subject_filter": { "description": "[Private Preview] Deprecated. Use include_subjects instead.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.299.2", @@ -8535,14 +8535,14 @@ "jar": { "description": "[Private Preview] URI of the jar to be installed. Currently only DBFS is supported.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "maven": { "description": "[Private Preview] Specification of a maven library to be installed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -8597,7 +8597,7 @@ "environment_version": { "description": "[Private Preview] The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.294.0" } @@ -8675,21 +8675,21 @@ "days_of_week": { "description": "[Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.234.0" }, "start_hour": { "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.234.0" }, "time_zone_id": { "description": "[Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.234.0" } @@ -8763,21 +8763,21 @@ "entity_type": { "description": "[Private Preview] (Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_ingestion_options": { "description": "[Private Preview] (Optional) File ingestion options for processing files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "url": { "description": "[Private Preview] Required. The SharePoint URL.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -8806,7 +8806,7 @@ "enforce_schema": { "description": "[Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -8841,7 +8841,7 @@ "google_ads_config": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -8935,7 +8935,7 @@ "salesforce_include_formula_fields": { "description": "[Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -8952,7 +8952,7 @@ "workday_report_parameters": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" } @@ -8980,49 +8980,49 @@ "data_level": { "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "dimensions": { "description": "[Private Preview] (Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "lookback_window_days": { "description": "[Private Preview] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", "$ref": "#/$defs/int", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "metrics": { "description": "[Private Preview] (Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", "$ref": "#/$defs/slice/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "query_lifetime": { "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "report_type": { "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "sync_start_date": { "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -9072,14 +9072,14 @@ "format": { "description": "[Private Preview] Required: the wire format of the data.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "json_options": { "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v1.1.0" } @@ -9104,7 +9104,7 @@ "start_date": { "description": "[Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", "$ref": "#/$defs/string", - "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } diff --git a/internal/clijson/launchstage.go b/internal/clijson/launchstage.go new file mode 100644 index 00000000000..b84d132ae4d --- /dev/null +++ b/internal/clijson/launchstage.go @@ -0,0 +1,46 @@ +package clijson + +import ( + "fmt" + "slices" +) + +// LaunchStage is a field, enum value, or type's release stage, carried by the +// contract's launch_stage. Only the constants below are valid. +// +// The producer currently emits launch_stage as a plain string, so SchemaJSON +// and SchemaFieldJSON store it as such and ParseLaunchStage enforces the closed +// set where the contract is consumed. Once the producer is upstreamed to emit +// this enum directly, no other value could reach the CLI. +type LaunchStage string + +const ( + LaunchStageGA LaunchStage = "GA" + LaunchStagePublicPreview LaunchStage = "PUBLIC_PREVIEW" + LaunchStagePublicBeta LaunchStage = "PUBLIC_BETA" + LaunchStagePrivatePreview LaunchStage = "PRIVATE_PREVIEW" +) + +// LaunchStages is the closed set of valid launch stages. ParseLaunchStage +// validates against it, so extending the contract with a new stage means adding +// it here too. +var LaunchStages = []LaunchStage{ + LaunchStageGA, + LaunchStagePublicPreview, + LaunchStagePublicBeta, + LaunchStagePrivatePreview, +} + +// ParseLaunchStage converts a raw launch_stage string from the contract into a +// LaunchStage, mapping the empty string to GA (the implicit default). It errors +// on any value outside the closed set. +func ParseLaunchStage(s string) (LaunchStage, error) { + if s == "" { + return LaunchStageGA, nil + } + stage := LaunchStage(s) + if !slices.Contains(LaunchStages, stage) { + return "", fmt.Errorf("unknown launch stage %q: add it to LaunchStages in internal/clijson/launchstage.go", s) + } + return stage, nil +} diff --git a/internal/clijson/launchstage_test.go b/internal/clijson/launchstage_test.go new file mode 100644 index 00000000000..d4f7f3ee917 --- /dev/null +++ b/internal/clijson/launchstage_test.go @@ -0,0 +1,47 @@ +package clijson + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestParseLaunchStage(t *testing.T) { + tests := []struct { + raw string + want LaunchStage + wantErr bool + }{ + {"", LaunchStageGA, false}, + {"GA", LaunchStageGA, false}, + {"PUBLIC_PREVIEW", LaunchStagePublicPreview, false}, + {"PUBLIC_BETA", LaunchStagePublicBeta, false}, + {"PRIVATE_PREVIEW", LaunchStagePrivatePreview, false}, + {"SOMETHING_ELSE", "", true}, + } + for _, tc := range tests { + got, err := ParseLaunchStage(tc.raw) + if tc.wantErr { + assert.Error(t, err, "ParseLaunchStage(%q)", tc.raw) + continue + } + require.NoError(t, err, "ParseLaunchStage(%q)", tc.raw) + assert.Equal(t, tc.want, got) + } +} + +// Every constant must be a member of LaunchStages, so a constant added without +// updating the closed set (or vice versa) is caught here. +func TestLaunchStagesContainsEveryConst(t *testing.T) { + for _, stage := range []LaunchStage{ + LaunchStageGA, + LaunchStagePublicPreview, + LaunchStagePublicBeta, + LaunchStagePrivatePreview, + } { + got, err := ParseLaunchStage(string(stage)) + require.NoError(t, err, "stage %q", stage) + assert.Equal(t, stage, got) + } +} diff --git a/libs/jsonschema/extension.go b/libs/jsonschema/extension.go index ece93180f0c..031c26ac642 100644 --- a/libs/jsonschema/extension.go +++ b/libs/jsonschema/extension.go @@ -41,12 +41,14 @@ type Extension struct { // from a different directory (e.g., "../default"). TemplateDir string `json:"template_dir,omitempty"` - // Preview indicates launch stage (e.g. PREVIEW). + // LaunchStage is the field's release stage from the cli.json contract. // - // This field indicates whether the associated field is part of a private preview feature. - // Currently, it is used exclusively by Python code generation to exclude certain fields - // from the generated Sphinx documentation. - Preview string `json:"x-databricks-preview,omitempty"` + // It is emitted only for private-preview fields. Python code generation reads + // it to exclude those fields from the generated Sphinx documentation. Other + // stages are not emitted here because nothing consumes them in the published + // schema (the stage already surfaces as a description prefix and as the + // per-value enumDescriptions labels). + LaunchStage string `json:"x-databricks-launch-stage,omitempty"` // EnumDescriptions is the parallel-array form emitted alongside Enum. VSCode // renders these next to each enum value in autocomplete dropdowns. Each entry diff --git a/python/codegen/codegen/generated_dataclass.py b/python/codegen/codegen/generated_dataclass.py index 9070a1e38c2..f9fbb448138 100644 --- a/python/codegen/codegen/generated_dataclass.py +++ b/python/codegen/codegen/generated_dataclass.py @@ -6,7 +6,7 @@ import codegen.packages as packages from codegen.code_builder import CodeBuilder -from codegen.jsonschema import Property, Schema, Stage +from codegen.jsonschema import LaunchStage, Property, Schema from codegen.packages import is_resource @@ -161,7 +161,7 @@ def generate_field( default=None, default_factory="dict", create_func_default="None", - experimental=prop.stage == Stage.PRIVATE, + experimental=prop.stage == LaunchStage.PRIVATE_PREVIEW, deprecated=prop.deprecated or False, ) elif field_type.name == "VariableOrList": @@ -174,7 +174,7 @@ def generate_field( default=None, default_factory="list", create_func_default="None", - experimental=prop.stage == Stage.PRIVATE, + experimental=prop.stage == LaunchStage.PRIVATE_PREVIEW, deprecated=prop.deprecated or False, ) elif is_required: @@ -187,7 +187,7 @@ def generate_field( default=None, default_factory=None, create_func_default=None, - experimental=prop.stage == Stage.PRIVATE, + experimental=prop.stage == LaunchStage.PRIVATE_PREVIEW, deprecated=prop.deprecated or False, ) else: @@ -200,7 +200,7 @@ def generate_field( default="None", default_factory=None, create_func_default="None", - experimental=prop.stage == Stage.PRIVATE, + experimental=prop.stage == LaunchStage.PRIVATE_PREVIEW, deprecated=prop.deprecated or False, ) @@ -335,7 +335,7 @@ def generate_dataclass( description=schema.description, fields=fields, extends=extends, - experimental=schema.stage == Stage.PRIVATE, + experimental=schema.stage == LaunchStage.PRIVATE_PREVIEW, deprecated=schema.deprecated or False, ) diff --git a/python/codegen/codegen/generated_enum.py b/python/codegen/codegen/generated_enum.py index f2eecf82e46..84bb79e957c 100644 --- a/python/codegen/codegen/generated_enum.py +++ b/python/codegen/codegen/generated_enum.py @@ -5,7 +5,7 @@ import codegen.packages as packages from codegen.code_builder import CodeBuilder from codegen.generated_dataclass import _append_description -from codegen.jsonschema import Schema, Stage +from codegen.jsonschema import LaunchStage, Schema @dataclass(kw_only=True) @@ -35,7 +35,7 @@ def generate_enum(namespace: str, schema_name: str, schema: Schema) -> Generated package=package, values=values, description=schema.description, - experimental=schema.stage == Stage.PRIVATE, + experimental=schema.stage == LaunchStage.PRIVATE_PREVIEW, deprecated=schema.deprecated or False, ) diff --git a/python/codegen/codegen/jsonschema.py b/python/codegen/codegen/jsonschema.py index ceed9203e7a..6c3c7dd58c3 100644 --- a/python/codegen/codegen/jsonschema.py +++ b/python/codegen/codegen/jsonschema.py @@ -7,8 +7,16 @@ import codegen.packages as packages -class Stage: - PRIVATE = "PRIVATE" +class LaunchStage: + # Mirrors clijson.LaunchStage in the Go code. jsonschema.json only carries + # x-databricks-launch-stage for private-preview fields (the Go schema + # generator emits it only there, to mark them experimental and exclude them + # from the generated documentation), but the full set is mirrored here for + # completeness. + GA = "GA" + PUBLIC_PREVIEW = "PUBLIC_PREVIEW" + PUBLIC_BETA = "PUBLIC_BETA" + PRIVATE_PREVIEW = "PRIVATE_PREVIEW" @dataclass @@ -101,7 +109,7 @@ def _parse_bool(value) -> Optional[bool]: ref=v["$ref"], description=v.get("description"), deprecated=_parse_bool(v.get("deprecated")), - stage=v.get("x-databricks-preview"), + stage=v.get("x-databricks-launch-stage"), ) properties[k] = prop @@ -118,7 +126,7 @@ def _parse_bool(value) -> Optional[bool]: required=schema.get("required", []), description=schema.get("description"), deprecated=_parse_bool(schema.get("deprecated")), - stage=schema.get("x-databricks-preview"), + stage=schema.get("x-databricks-launch-stage"), ) diff --git a/python/codegen/codegen/main.py b/python/codegen/codegen/main.py index d8764775c5a..66fd1fb6716 100644 --- a/python/codegen/codegen/main.py +++ b/python/codegen/codegen/main.py @@ -65,7 +65,7 @@ def _transitively_mark_deprecated_and_private( for schema_name, schema in schemas.items(): if schema_name not in not_private: - schema.stage = openapi.Stage.PRIVATE + schema.stage = openapi.LaunchStage.PRIVATE_PREVIEW if schema_name not in not_deprecated: schema.deprecated = True @@ -88,7 +88,10 @@ def _remove_deprecated_fields( if schema.type == openapi.SchemaType.OBJECT: new_properties = {} for field_name, field in schema.properties.items(): - if field.deprecated and field.stage == openapi.Stage.PRIVATE: + if ( + field.deprecated + and field.stage == openapi.LaunchStage.PRIVATE_PREVIEW + ): continue new_properties[field_name] = field @@ -254,7 +257,10 @@ def _collect_reachable_schemas( if field.ref: name = field.ref.split("/")[-1] - if not include_private and field.stage == openapi.Stage.PRIVATE: + if ( + not include_private + and field.stage == openapi.LaunchStage.PRIVATE_PREVIEW + ): continue if not include_deprecated and field.deprecated: