diff --git a/.vscode/settings.json b/.vscode/settings.json index a0f74f88ac1..b393450c80d 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -22,5 +22,11 @@ "script": "shellscript", "script.prepare": "shellscript", "script.cleanup": "shellscript" + }, + "yaml.schemas": { + "./bundle/schema/jsonschema.json": [ + "databricks.yml", + "databricks.yaml", + ] } } diff --git a/bundle/internal/annotation/descriptor.go b/bundle/internal/annotation/descriptor.go index 797746b0df8..be452a748b5 100644 --- a/bundle/internal/annotation/descriptor.go +++ b/bundle/internal/annotation/descriptor.go @@ -1,15 +1,18 @@ package annotation 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"` - 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"` + 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"` } const Placeholder = "PLACEHOLDER" diff --git a/bundle/internal/annotation/preview.go b/bundle/internal/annotation/preview.go new file mode 100644 index 00000000000..3b9973ebebb --- /dev/null +++ b/bundle/internal/annotation/preview.go @@ -0,0 +1,15 @@ +package annotation + +// 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 "" +} diff --git a/bundle/internal/annotation/preview_test.go b/bundle/internal/annotation/preview_test.go new file mode 100644 index 00000000000..b6f5977cb4a --- /dev/null +++ b/bundle/internal/annotation/preview_test.go @@ -0,0 +1,25 @@ +package annotation_test + +import ( + "testing" + + "github.com/databricks/cli/bundle/internal/annotation" + "github.com/stretchr/testify/assert" +) + +func TestPreviewTag(t *testing.T) { + tests := []struct { + launchStage string + want string + }{ + {"PUBLIC_PREVIEW", "[Public Preview]"}, + {"PUBLIC_BETA", "[Beta]"}, + {"PRIVATE_PREVIEW", "[Private Preview]"}, + {"GA", ""}, + {"", ""}, + {"SOMETHING_ELSE", ""}, + } + for _, tc := range tests { + assert.Equal(t, tc.want, annotation.PreviewTag(tc.launchStage)) + } +} diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index 2889fffe81c..a9d3b2cfeaa 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -134,6 +134,13 @@ 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" { s.DoNotSuggest = true s.Preview = a.Preview @@ -146,6 +153,54 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { s.MarkdownDescription = convertLinksToAbsoluteUrl(a.MarkdownDescription) s.Title = a.Title s.Enum = a.Enum + s.EnumDescriptions = buildEnumDescriptions(a.Enum, a.EnumLaunchStages, a.EnumDescriptions) + + // Surface launch stage in hover tooltips. Editors only render the standard + // description field, so the tag is baked into the text. + if tag := annotation.PreviewTag(a.LaunchStage); tag != "" { + s.Description = prefixWithPreviewTag(s.Description, tag) + } +} + +// buildEnumDescriptions produces the parallel enumDescriptions array VSCode +// renders next to each enum value. Each entry combines the launch-stage tag +// 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 { + if len(enum) == 0 || (len(launchStages) == 0 && len(descriptions) == 0) { + return nil + } + result := make([]string, len(enum)) + hasContent := false + for i, v := range enum { + key, ok := v.(string) + if !ok { + continue + } + result[i] = prefixWithPreviewTag(descriptions[key], annotation.PreviewTag(launchStages[key])) + if result[i] != "" { + hasContent = true + } + } + if !hasContent { + return nil + } + return result +} + +// prefixWithPreviewTag prepends the launch-stage tag to a description while +// guarding against double-tagging — if the description already starts with +// the tag, it is returned unchanged. An empty tag (GA) also takes the +// HasPrefix path, returning the description as-is. +func prefixWithPreviewTag(description, tag string) string { + if description == "" { + return tag + } + if strings.HasPrefix(description, tag) { + return description + } + return tag + " " + description } func saveYamlWithStyle(outputPath string, annotations annotation.File) error { diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml index dc2d93c357a..1c301cdc92f 100644 --- a/bundle/internal/schema/annotations_openapi.yml +++ b/bundle/internal/schema/annotations_openapi.yml @@ -5,15 +5,23 @@ github.com/databricks/cli/bundle/config/resources.Alert: The timestamp indicating when the alert was created. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "custom_description": "description": |- Custom description for the alert. support mustache template. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "custom_summary": "description": |- Custom summary for the alert. support mustache template. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "display_name": "description": |- The display name of the alert. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_run_as": "description": |- The actual identity that will be used to execute the alert. @@ -21,28 +29,42 @@ github.com/databricks/cli/bundle/config/resources.Alert: permissions and defaults. "x-databricks-field-behaviors_output_only": |- true - "evaluation": {} + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "evaluation": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "id": "description": |- UUID identifying the alert. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "lifecycle_state": "description": |- Indicates whether the query is trashed. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "owner_user_name": "description": |- The owner's username. This field is set to "Unavailable" if the user has been deleted. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "parent_path": "description": |- The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "query_text": "description": |- Text of the query to be run. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "run_as": "description": |- Specifies the identity that will be used to run the alert. @@ -50,6 +72,8 @@ github.com/databricks/cli/bundle/config/resources.Alert: - For user identity: Set `user_name` to the email of an active workspace user. Users can only set this to their own email. - For service principal: Set `service_principal_name` to the application ID. Requires the `servicePrincipal/user` role. If not specified, the alert will run as the request user. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "run_as_user_name": "description": |- The run as username or application ID of service principal. @@ -57,15 +81,23 @@ github.com/databricks/cli/bundle/config/resources.Alert: Deprecated: Use `run_as` field instead. This field will be removed in a future release. "deprecation_message": |- This field is deprecated - "schedule": {} + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "schedule": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "update_time": "description": |- The timestamp indicating when the alert was updated. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "warehouse_id": "description": |- ID of the SQL warehouse attached to the alert. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/cli/bundle/config/resources.App: "active_deployment": "description": |- @@ -76,15 +108,21 @@ github.com/databricks/cli/bundle/config/resources.App: "app_status": "x-databricks-field-behaviors_output_only": |- true - "budget_policy_id": {} + "budget_policy_id": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "compute_max_instances": "description": |- 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": {} @@ -113,14 +151,20 @@ github.com/databricks/cli/bundle/config/resources.App: "effective_budget_policy_id": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_usage_policy_id": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_user_api_scopes": "description": |- The effective api scopes granted to the user access token. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "git_repository": "description": |- Git repository configuration for app deployments. When specified, deployments can @@ -137,9 +181,13 @@ github.com/databricks/cli/bundle/config/resources.App: "oauth2_app_client_id": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "oauth2_app_integration_id": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "pending_deployment": "description": |- The pending deployment of the app. A deployment is considered pending when it is being prepared @@ -161,9 +209,13 @@ github.com/databricks/cli/bundle/config/resources.App: "space": "description": |- Name of the space this app belongs to. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE - "telemetry_export_destinations": {} + "telemetry_export_destinations": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "thumbnail_url": "description": |- The URL of the thumbnail image for the app. @@ -184,8 +236,12 @@ github.com/databricks/cli/bundle/config/resources.App: The URL of the app once it is deployed. "x-databricks-field-behaviors_output_only": |- true - "usage_policy_id": {} - "user_api_scopes": {} + "usage_policy_id": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "user_api_scopes": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/cli/bundle/config/resources.Catalog: "comment": "description": |- @@ -413,19 +469,29 @@ github.com/databricks/cli/bundle/config/resources.Cluster: "description": |- Cluster Attributes showing for clusters workload types. github.com/databricks/cli/bundle/config/resources.DatabaseCatalog: - "create_database_if_not_exists": {} + "create_database_if_not_exists": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "database_instance_name": "description": |- The name of the DatabaseInstance housing the database. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "database_name": "description": |- The name of the database (in a instance) associated with the catalog. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- The name of the catalog in UC. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "uid": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/cli/bundle/config/resources.DatabaseInstance: "_": "description": |- @@ -433,25 +499,35 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: "capacity": "description": |- The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8". + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "child_instance_refs": "description": |- The refs of the child instances. This is only available if the instance is parent instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "creation_time": "description": |- The timestamp when the instance was created. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "creator": "description": |- The email of the creator of the instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "custom_tags": "description": |- Custom tags associated with the instance. This field is only included on create and update responses. + "x-databricks-launch-stage": |- + PUBLIC_BETA "effective_capacity": "description": |- Deprecated. The sku of the instance; this field will always match the value of capacity. @@ -461,6 +537,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: This field is deprecated "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_custom_tags": "description": |- The recorded custom tags associated with the instance. @@ -468,6 +546,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_BETA "effective_enable_pg_native_login": "description": |- Whether the instance has PG native password login enabled. @@ -475,6 +555,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_enable_readable_secondaries": "description": |- Whether secondaries serving read-only traffic are enabled. Defaults to false. @@ -482,6 +564,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_node_count": "description": |- The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to @@ -490,6 +574,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_retention_window_in_days": "description": |- The retention window for the instance. This is the time window in days @@ -498,6 +584,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_stopped": "description": |- Whether the instance is stopped. @@ -505,6 +593,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_usage_policy_id": "description": |- The policy that is applied to the instance. @@ -512,62 +602,90 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_BETA "enable_pg_native_login": "description": |- Whether to enable PG native password login on the instance. Defaults to false. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "enable_readable_secondaries": "description": |- Whether to enable secondaries to serve read-only traffic. Defaults to false. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- The name of the instance. This is the unique identifier for the instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "node_count": "description": |- The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries. This field is input only, see effective_node_count for the output. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "parent_instance_ref": "description": |- The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "pg_version": "description": |- The version of Postgres running on the instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "read_only_dns": "description": |- The DNS endpoint to connect to the instance for read only access. This is only available if enable_readable_secondaries is true. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "read_write_dns": "description": |- The DNS endpoint to connect to the instance for read+write access. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "retention_window_in_days": "description": |- The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "state": "description": |- The current state of the instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "stopped": "description": |- Whether to stop the instance. An input only param, see effective_stopped for the output. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "uid": "description": |- An immutable UUID identifier for the instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "usage_policy_id": "description": |- The desired usage policy to associate with the instance. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/cli/bundle/config/resources.ExternalLocation: "comment": "description": |- @@ -619,6 +737,8 @@ github.com/databricks/cli/bundle/config/resources.Job: The id of the user specified budget policy to use for this job. If not specified, a default budget policy may be applied when creating or modifying the job. See `effective_budget_policy_id` for the budget policy used by this workload. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "continuous": "description": |- An optional continuous property for this job. The continuous property will ensure that there is always one run executing. Only one of `schedule` and `continuous` can be used. @@ -714,6 +834,8 @@ github.com/databricks/cli/bundle/config/resources.Job: The id of the user specified usage policy to use for this job. If not specified, a default usage policy may be applied when creating or modifying the 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": @@ -779,6 +901,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "budget_policy_id": "description": |- Budget policy of this pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "catalog": "description": |- A catalog in Unity Catalog to publish data from this pipeline to. If `target` is specified, tables in this pipeline are published to a `target` schema inside `catalog` (for example, `catalog`.`target`.`table`). If `target` is not specified, no data is published to Unity Catalog. @@ -807,6 +931,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "environment": "description": |- Environment specification for this pipeline used to install dependencies. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "event_log": "description": |- Event log configuration for this pipeline @@ -816,6 +942,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "gateway_definition": "description": |- The definition of a gateway pipeline to support change data capture. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "id": @@ -824,6 +952,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "ingestion_definition": "description": |- The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "libraries": "description": |- Libraries or code needed by this deployment. @@ -837,12 +967,16 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "description": |- Key/value map of default parameters to use for pipeline execution. Maximum total size: 10k characters (JSON format) + "x-databricks-launch-stage": |- + PUBLIC_BETA "photon": "description": |- Whether Photon is enabled for this pipeline. "restart_window": "description": |- Restart window of this pipeline. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "root_path": @@ -850,6 +984,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: Root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline execution. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "run_as": "description": |- Write-only setting, available only in Create/Update calls. Specifies the user or service principal that the pipeline runs as. If not specified, the pipeline runs as the user who created the pipeline. @@ -882,6 +1018,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "usage_policy_id": "description": |- Usage policy of this pipeline. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/cli/bundle/config/resources.QualityMonitor: @@ -900,6 +1038,8 @@ github.com/databricks/cli/bundle/config/resources.QualityMonitor: "data_classification_config": "description": |- [Create:OPT Update:OPT] Data classification related config. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "inference_log": {} @@ -1096,12 +1236,16 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: Synced Table data synchronization status "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "database_instance_name": "description": |- Name of the target database instance. This is required when creating synced database tables in standard catalogs. This is optional when creating synced database tables in registered catalogs. If this field is specified when creating synced database tables in registered catalogs, the database instance name MUST match that of the registered catalog (or the request will be rejected). + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_database_instance_name": "description": |- The name of the database instance that this table is registered to. This field is always returned, and for @@ -1110,6 +1254,8 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_logical_database_name": "description": |- The name of the logical database that this table is registered to. @@ -1117,6 +1263,8 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "logical_database_name": "description": |- Target Postgres database object (logical database) name for this table. @@ -1129,12 +1277,18 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: When creating a synced table in a standard catalog, this field is required. In this scenario, specifying this field will allow targeting an arbitrary postgres database. Note that this has implications for the `create_database_objects_is_missing` field in `spec`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- Full three-part (catalog, schema, table) name of the table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "spec": "description": |- Specification of a synced database table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "unity_catalog_provisioning_state": "description": |- The provisioning state of the synced table entity in Unity Catalog. This is distinct from the @@ -1142,10 +1296,14 @@ github.com/databricks/cli/bundle/config/resources.SyncedDatabaseTable: may be in "PROVISIONING" as it runs asynchronously). "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/cli/bundle/config/resources.VectorSearchEndpoint: "budget_policy_id": "description": |- The budget policy id to be applied + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "endpoint_type": "description": |- Type of endpoint @@ -1157,9 +1315,13 @@ github.com/databricks/cli/bundle/config/resources.VectorSearchEndpoint: Target QPS for the endpoint. Mutually exclusive with num_replicas. The actual replica count is calculated at index creation/sync time based on this value. Best-effort target; the system does not guarantee this QPS will be achieved. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "usage_policy_id": "description": |- 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: @@ -1175,6 +1337,8 @@ github.com/databricks/cli/bundle/config/resources.VectorSearchIndex: "index_subtype": "description": |- The subtype of the index. Use `HYBRID` or `FULL_TEXT`. `VECTOR` is not supported. + "x-databricks-launch-stage": |- + PUBLIC_BETA "index_type": "description": |- There are 2 types of AI Search indexes: @@ -1527,6 +1691,8 @@ github.com/databricks/databricks-sdk-go/service/apps.ComputeStatus: to handle requests. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "message": @@ -1711,6 +1877,8 @@ github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificatio "enabled": "description": |- Whether to enable data classification. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination: @@ -1796,6 +1964,8 @@ github.com/databricks/databricks-sdk-go/service/catalog.MonitorNotifications: "on_new_classification_tag_detected": "description": |- 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: @@ -2362,6 +2532,11 @@ github.com/databricks/databricks-sdk-go/service/compute.ConfidentialComputeType: CONFIDENTIAL_COMPUTE_TYPE_NONE - |- SEV_SNP + "x-databricks-enum-launch-stages": + "CONFIDENTIAL_COMPUTE_TYPE_NONE": |- + PRIVATE_PREVIEW + "SEV_SNP": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode: "_": "description": |- @@ -2405,6 +2580,25 @@ github.com/databricks/databricks-sdk-go/service/compute.DataSecurityMode: DATA_SECURITY_MODE_DEDICATED - |- DATA_SECURITY_MODE_AUTO + "x-databricks-enum-descriptions": + "DATA_SECURITY_MODE_AUTO": |- + will choose the most appropriate access mode depending on your compute configuration. + "DATA_SECURITY_MODE_DEDICATED": |- + A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. + "DATA_SECURITY_MODE_STANDARD": |- + A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + "LEGACY_PASSTHROUGH": |- + This mode is for users migrating from legacy Passthrough on high concurrency clusters. + "LEGACY_SINGLE_USER": |- + This mode is for users migrating from legacy Passthrough on standard clusters. + "LEGACY_SINGLE_USER_STANDARD": |- + This mode provides a way that doesn’t have UC nor passthrough enabled. + "LEGACY_TABLE_ACL": |- + This mode is for users migrating from legacy Table ACL clusters. + "SINGLE_USER": |- + Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. + "USER_ISOLATION": |- + Legacy alias for `DATA_SECURITY_MODE_STANDARD`. github.com/databricks/databricks-sdk-go/service/compute.DbfsStorageInfo: "_": "description": |- @@ -2470,6 +2664,8 @@ github.com/databricks/databricks-sdk-go/service/compute.Environment: "java_dependencies": "description": |- List of java dependencies. Each dependency is a string representing a java library path. For example: `/Volumes/path/to/test.jar`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes: "_": "description": |- @@ -2486,6 +2682,8 @@ github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes: The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "first_on_demand": @@ -2554,6 +2752,11 @@ github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType: GPU_1xA10 - |- GPU_8xH100 + "x-databricks-enum-launch-stages": + "GPU_1xA10": |- + PUBLIC_BETA + "GPU_8xH100": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo: "_": "description": |- @@ -2763,9 +2966,13 @@ github.com/databricks/databricks-sdk-go/service/database.CustomTag: "key": "description": |- The key of the custom tag. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "value": "description": |- The value of the custom tag. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef: "_": "description": |- @@ -2786,6 +2993,8 @@ github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef: instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "effective_lsn": "description": |- For a parent ref instance, this is the LSN on the parent instance from which the @@ -2796,20 +3005,28 @@ github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef: server side defaults. Use the field without the effective_ prefix to set the value. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "lsn": "description": |- User-specified WAL LSN of the ref database instance. Input: For specifying the WAL LSN to create a child instance. Optional. Output: Only populated if provided as input to create a child instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- Name of the ref database instance. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "uid": "description": |- Id of the ref database instance. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceState: "_": "enum": @@ -2825,6 +3042,19 @@ github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceState: UPDATING - |- FAILING_OVER + "x-databricks-enum-launch-stages": + "AVAILABLE": |- + PUBLIC_PREVIEW + "DELETING": |- + PUBLIC_PREVIEW + "FAILING_OVER": |- + PUBLIC_PREVIEW + "STARTING": |- + PUBLIC_PREVIEW + "STOPPED": |- + PUBLIC_PREVIEW + "UPDATING": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.DeltaTableSyncInfo: "delta_commit_timestamp": "description": |- @@ -2832,11 +3062,15 @@ github.com/databricks/databricks-sdk-go/service/database.DeltaTableSyncInfo: Note: This is the Delta commit time, not the time the data was written to the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "delta_commit_version": "description": |- The Delta Lake commit version that was last successfully synced. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec: "_": "description": |- @@ -2845,18 +3079,24 @@ github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec: "budget_policy_id": "description": |- Budget policy to set on the newly created pipeline. + "x-databricks-launch-stage": |- + PUBLIC_BETA "storage_catalog": "description": |- This field needs to be specified if the destination catalog is a managed postgres catalog. UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "storage_schema": "description": |- This field needs to be specified if the destination catalog is a managed postgres catalog. UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.ProvisioningInfoState: "_": "enum": @@ -2872,6 +3112,19 @@ github.com/databricks/databricks-sdk-go/service/database.ProvisioningInfoState: UPDATING - |- DEGRADED + "x-databricks-enum-launch-stages": + "ACTIVE": |- + PUBLIC_PREVIEW + "DEGRADED": |- + PUBLIC_PREVIEW + "DELETING": |- + PUBLIC_PREVIEW + "FAILED": |- + PUBLIC_PREVIEW + "PROVISIONING": |- + PUBLIC_PREVIEW + "UPDATING": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.ProvisioningPhase: "_": "enum": @@ -2881,6 +3134,13 @@ github.com/databricks/databricks-sdk-go/service/database.ProvisioningPhase: PROVISIONING_PHASE_INDEX_SCAN - |- PROVISIONING_PHASE_INDEX_SORT + "x-databricks-enum-launch-stages": + "PROVISIONING_PHASE_INDEX_SCAN": |- + PUBLIC_PREVIEW + "PROVISIONING_PHASE_INDEX_SORT": |- + PUBLIC_PREVIEW + "PROVISIONING_PHASE_MAIN": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus: "_": "description": |- @@ -2891,17 +3151,23 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUp Progress of the initial data synchronization. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "last_processed_commit_version": "description": |- The last source table Delta version that was successfully synced to the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timestamp": "description": |- The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus: "_": "description": |- @@ -2915,12 +3181,16 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus synced and available for serving. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timestamp": "description": |- The end timestamp of the last time any data was synchronized from the source table to the synced table. Only populated if the table is still synced and available for serving. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTablePipelineProgress: "_": "description": |- @@ -2930,42 +3200,58 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTablePipelineProg The estimated time remaining to complete this update in seconds. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "latest_version_currently_processing": "description": |- The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "provisioning_phase": "description": |- The current phase of the data synchronization pipeline. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "sync_progress_completion": "description": |- The completion ratio of this update. This is a number between 0 and 1. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "synced_row_count": "description": |- The number of rows that have been synced in this update. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "total_row_count": "description": |- The total number of rows that need to be synced in this update. This number may be an estimate. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTablePosition: "delta_table_sync_info": "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "sync_end_timestamp": "description": |- The end timestamp of the most recent successful synchronization. This is the time when the data is available in the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "sync_start_timestamp": "description": |- The starting timestamp of the most recent successful synchronization from the source table @@ -2974,6 +3260,8 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTablePosition: E.g., for a batch, this is the time when the sync operation started. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioningStatus: "_": "description": |- @@ -2985,6 +3273,8 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioning PROVISIONING_INITIAL_SNAPSHOT state. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPolicy: "_": "enum": @@ -2994,6 +3284,13 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPo TRIGGERED - |- SNAPSHOT + "x-databricks-enum-launch-stages": + "CONTINUOUS": |- + PUBLIC_PREVIEW + "SNAPSHOT": |- + PUBLIC_PREVIEW + "TRIGGERED": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec: "_": "description": |- @@ -3002,6 +3299,8 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec: "description": |- If true, the synced table's logical database and schema resources in PG will be created if they do not already exist. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "existing_pipeline_id": "description": |- At most one of existing_pipeline_id and new_pipeline_spec should be defined. @@ -3009,6 +3308,8 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec: If existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline referenced. This avoids creating a new pipeline and allows sharing existing compute. In this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "new_pipeline_spec": "description": |- At most one of existing_pipeline_id and new_pipeline_spec should be defined. @@ -3017,18 +3318,28 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec: to store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta tables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table only requires read permissions. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "primary_key_columns": "description": |- Primary Key columns to be used for data insert/update in the destination. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "scheduling_policy": "description": |- Scheduling policy of the underlying pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_table_full_name": "description": |- Three-part (catalog, schema, table) name of the source Delta table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timeseries_key": "description": |- Time series key to deduplicate (tie-break) rows with the same primary key. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableState: "_": "description": |- @@ -3056,6 +3367,29 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableState: SYNCED_TABLE_ONLINE_PIPELINE_FAILED - |- SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES + "x-databricks-enum-launch-stages": + "SYNCED_TABLED_OFFLINE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_OFFLINE_FAILED": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_PIPELINE_FAILED": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_PROVISIONING": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT": |- + PUBLIC_PREVIEW + "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableStatus: "_": "description": |- @@ -3064,15 +3398,21 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableStatus: "description": |- Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE or the SYNCED_UPDATING_PIPELINE_RESOURCES state. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "detailed_state": "description": |- The state of the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "failed_status": "description": |- Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the SYNCED_PIPELINE_FAILED state. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "last_sync": "description": |- Summary of the last successful synchronization from source to destination. @@ -3087,25 +3427,35 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableStatus: without having to traverse detailed_status. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "message": "description": |- A text description of the current state of the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "pipeline_id": "description": |- ID of the associated pipeline. The pipeline ID may have been provided by the client (in the case of bin packing), or generated by the server (when creating a new pipeline). "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "provisioning_status": "description": |- Detailed status of a synced table. Shown if the synced table is in the PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "triggered_update_status": "description": |- Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE or the SYNCED_NO_PENDING_UPDATE state. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpdateStatus: "_": "description": |- @@ -3116,17 +3466,23 @@ github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpd The last source table Delta version that was successfully synced to the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timestamp": "description": |- The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "triggered_update_progress": "description": |- Progress of the active data synchronization pipeline. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/iam.PermissionLevel: "_": "description": |- @@ -3172,32 +3528,49 @@ github.com/databricks/databricks-sdk-go/service/iam.PermissionLevel: CAN_MONITOR_ONLY - |- CAN_CREATE_APP + "x-databricks-enum-launch-stages": + "CAN_CREATE_APP": |- + PRIVATE_PREVIEW + "CAN_MONITOR_ONLY": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.AlertTask: "alert_id": "description": |- The alert_id is the canonical identifier of the alert. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "subscribers": "description": |- The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "warehouse_id": "description": |- The warehouse_id identifies the warehouse settings used by the alert task. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "workspace_path": "description": |- The workspace_path is the path to the alert file in the workspace. The path: * must start with "/Workspace" * must be a normalized path. User has to select only one of alert_id or workspace_path to identify the alert. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber: "_": "description": |- Represents a subscriber that will receive alert notifications. A subscriber can be either a user (via email) or a notification destination (via destination_id). - "destination_id": {} + "destination_id": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "user_name": "description": |- A valid workspace email address. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod: "_": "enum": @@ -3205,6 +3578,11 @@ github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod: OAUTH - |- PAT + "x-databricks-enum-launch-stages": + "OAUTH": |- + PUBLIC_PREVIEW + "PAT": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.CleanRoomsNotebookTask: "_": "description": |- @@ -3227,20 +3605,28 @@ github.com/databricks/databricks-sdk-go/service/jobs.Compute: "hardware_accelerator": "description": |- Hardware accelerator configuration for Serverless GPU workloads. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig: "gpu_node_pool_id": "description": |- 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: @@ -3315,6 +3701,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.DashboardTask: - For date and datetime filters, provide the value in ISO 8601 format (e.g. `"2000-01-01T00:00:00"`) - For multi-select filters, provide a JSON array of values (e.g. `"[\"value1\",\"value2\"]"`) - 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": @@ -3331,22 +3719,30 @@ github.com/databricks/databricks-sdk-go/service/jobs.DbtCloudTask: "connection_resource_name": "description": |- 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: @@ -3413,20 +3809,28 @@ github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask: "command": "description": |- 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": @@ -3435,22 +3839,30 @@ github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask: defined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise. * `WORKSPACE`: Script is located in Databricks workspace. * `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: @@ -3510,6 +3922,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.GitSource: The source of the job specification in the remote repository when the job is source controlled. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sparse_checkout": {} @@ -3527,6 +3941,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobDeployment: ID of the deployment that manages this job. Only set when `kind` is `BUNDLE`. Used to look up deployment metadata from the Deployment Metadata service. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "kind": @@ -3543,6 +3959,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobDeployment: ID of the version of the deployment that produced this job. Only set when `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment in the Deployment Metadata service. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.JobDeploymentKind: @@ -3555,6 +3973,14 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobDeploymentKind: BUNDLE - |- SYSTEM_MANAGED + "x-databricks-enum-descriptions": + "BUNDLE": |- + The job is managed by Databricks Asset Bundle. + "SYSTEM_MANAGED": |- + The job is managed by and is read-only. + "x-databricks-enum-launch-stages": + "SYSTEM_MANAGED": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/jobs.JobEditMode: "_": "description": |- @@ -3567,6 +3993,11 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobEditMode: UI_LOCKED - |- EDITABLE + "x-databricks-enum-descriptions": + "EDITABLE": |- + The job is in an editable state and can be modified. + "UI_LOCKED": |- + The job is in a locked UI state and cannot be modified. github.com/databricks/databricks-sdk-go/service/jobs.JobEmailNotifications: "no_alert_for_skipped_runs": "description": |- @@ -3588,6 +4019,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobEmailNotifications: A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "on_success": "description": |- A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent. @@ -3635,6 +4068,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobRunAs: "group_name": "description": |- 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": @@ -3654,16 +4089,22 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobSource: Possible values are: * `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. * `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: @@ -3680,6 +4121,16 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState: NOT_SYNCED - |- DISCONNECTED + "x-databricks-enum-descriptions": + "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. + "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. + "x-databricks-enum-launch-stages": + "DISCONNECTED": |- + PRIVATE_PREVIEW + "NOT_SYNCED": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric: "_": "description": |- @@ -3701,6 +4152,17 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthMetric: STREAMING_BACKLOG_SECONDS - |- STREAMING_BACKLOG_FILES + "x-databricks-enum-descriptions": + "RUN_DURATION_SECONDS": |- + Expected total time for a run in seconds. + "STREAMING_BACKLOG_BYTES": |- + An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview. + "STREAMING_BACKLOG_FILES": |- + An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview. + "STREAMING_BACKLOG_RECORDS": |- + An estimate of the maximum offset lag across all streams. This metric is in Public Preview. + "STREAMING_BACKLOG_SECONDS": |- + An estimate of the maximum consumer delay across all streams. This metric is in Public Preview. github.com/databricks/databricks-sdk-go/service/jobs.JobsHealthOperator: "_": "description": |- @@ -3733,23 +4195,31 @@ github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration: "aliases": "description": |- 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": @@ -3757,6 +4227,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration: If set, the trigger starts a run only after no model updates have occurred for the specified time and can be used to wait for a series of model updates before triggering a run. The 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: @@ -3768,6 +4240,13 @@ github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCo MODEL_VERSION_READY - |- MODEL_ALIAS_SET + "x-databricks-enum-launch-stages": + "MODEL_ALIAS_SET": |- + PRIVATE_PREVIEW + "MODEL_CREATED": |- + PRIVATE_PREVIEW + "MODEL_VERSION_READY": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.NotebookTask: "base_parameters": "description": |- @@ -3839,16 +4318,24 @@ github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams: "full_refresh_selection": "description": |- A list of tables to update with fullRefresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "refresh_flow_selection": "description": |- Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "refresh_selection": "description": |- A list of tables to update without fullRefresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "reset_checkpoint_selection": "description": |- A list of streaming flows to reset checkpoints without clearing data. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask: "full_refresh": "description": |- @@ -3856,10 +4343,14 @@ github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask: "full_refresh_selection": "description": |- A list of tables to update with fullRefresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "parameters": "description": |- Key/value-map of parameters passed to the pipeline execution. Limited to 10k characters in total. + "x-databricks-launch-stage": |- + PUBLIC_BETA "pipeline_id": "description": |- The full name of the pipeline task to execute. @@ -3867,75 +4358,117 @@ github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask: "description": |- Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "refresh_selection": "description": |- A list of tables to update without fullRefresh. + "x-databricks-launch-stage": |- + PUBLIC_BETA "reset_checkpoint_selection": "description": |- A list of streaming flows to reset checkpoints without clearing data. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/jobs.PowerBiModel: "authentication_method": "description": |- How the published Power BI model authenticates to Databricks + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "model_name": "description": |- The name of the Power BI model + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "overwrite_existing": "description": |- Whether to overwrite existing Power BI models + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "storage_mode": "description": |- The default storage mode of the Power BI model + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "workspace_name": "description": |- The name of the Power BI workspace of the model + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable: "catalog": "description": |- The catalog name in Databricks + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "name": "description": |- The table name in Databricks + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "schema": "description": |- The schema name in Databricks + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "storage_mode": "description": |- The Power BI storage mode of the table + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask: "connection_resource_name": "description": |- The resource name of the UC connection to authenticate from Databricks to Power BI + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "power_bi_model": "description": |- The semantic model to update + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "refresh_after_update": "description": |- Whether the model should be refreshed after the update + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "tables": "description": |- The tables to be exported to Power BI + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "warehouse_id": "description": |- The SQL warehouse ID to use as the Power BI data source + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask: "main": "description": |- Fully qualified name of the main class or function. 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: @@ -3980,6 +4513,19 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunIf: ALL_FAILED - |- AT_LEAST_ONE_FAILED + "x-databricks-enum-descriptions": + "ALL_DONE": |- + All dependencies have been completed + "ALL_FAILED": |- + ALl dependencies have failed + "ALL_SUCCESS": |- + All dependencies have executed and succeeded + "AT_LEAST_ONE_FAILED": |- + At least one dependency failed + "AT_LEAST_ONE_SUCCESS": |- + At least one dependency has succeeded + "NONE_FAILED": |- + None of the dependencies have failed and at least one was executed github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: "dbt_commands": "description": |- @@ -3988,6 +4534,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: ⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "jar_params": @@ -4001,6 +4549,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: ⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "job_id": @@ -4023,6 +4573,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: The JSON representation of this field (for example `{"notebook_params":{"name":"john doe","age":"35"}}`) cannot exceed 10,000 bytes. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "pipeline_params": @@ -4031,6 +4583,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: "python_named_params": "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "python_params": @@ -4048,6 +4602,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: Examples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "spark_submit_params": @@ -4065,6 +4621,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: Examples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sql_params": @@ -4074,6 +4632,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.RunJobTask: ⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE github.com/databricks/databricks-sdk-go/service/jobs.Source: @@ -4090,6 +4650,11 @@ github.com/databricks/databricks-sdk-go/service/jobs.Source: WORKSPACE - |- GIT + "x-databricks-enum-descriptions": + "GIT": |- + SQL file is located in cloud Git provider. + "WORKSPACE": |- + SQL file is located in workspace. github.com/databricks/databricks-sdk-go/service/jobs.SparkJarTask: "jar_uri": "description": |- @@ -4214,6 +4779,13 @@ github.com/databricks/databricks-sdk-go/service/jobs.StorageMode: IMPORT - |- DUAL + "x-databricks-enum-launch-stages": + "DIRECT_QUERY": |- + PUBLIC_PREVIEW + "DUAL": |- + PUBLIC_PREVIEW + "IMPORT": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.Subscription: "custom_subject": "description": |- @@ -4253,6 +4825,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "description": |- The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "clean_rooms_notebook_task": "description": |- The task runs a [clean rooms](https://docs.databricks.com/clean-rooms/index.html) notebook @@ -4260,6 +4834,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "compute": "description": |- Task level compute configuration. + "x-databricks-launch-stage": |- + PUBLIC_BETA "condition_task": "description": |- The task evaluates a condition that can be used to control the execution of other tasks when the `condition_task` field is present. @@ -4272,9 +4848,13 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task "deprecation_message": |- 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": @@ -4309,6 +4889,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "description": |- The task executes a nested task for every input provided when the `for_each_task` field is present. "gen_ai_compute_task": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "health": @@ -4342,9 +4924,13 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "power_bi_task": "description": |- The task triggers a Power BI semantic model update when the `power_bi_task` field is present. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "python_operator_task": "description": |- The task runs a Python operator task. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "python_wheel_task": @@ -4420,6 +5006,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.TaskEmailNotifications: A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "on_success": "description": |- A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESS` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent. @@ -4450,6 +5038,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.TriggerSettings: "description": |- File arrival trigger settings. "model": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "pause_status": @@ -4477,6 +5067,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications: Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. A maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "on_success": "description": |- An optional list of system notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified for the `on_success` property. @@ -4533,11 +5125,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy: "enabled": "description": |- (Required, Mutable) Whether to enable auto full refresh or not. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "min_interval_hours": "description": |- (Optional, Mutable) Specify the minimum interval in hours between the timestamp at which a table was last full refreshed and the current timestamp for triggering auto full If unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions: "_": "description": |- @@ -4545,6 +5141,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOpt "include_confluence_spaces": "description": |- (Optional) Spaces to filter Confluence data on + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters: "source_catalog": "description": |- @@ -4552,6 +5150,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters: This is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have in some other database systems like Postgres. 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: @@ -4561,7 +5161,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: "confluence_options": "description": |- Confluence specific options for ingestion + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "gdrive_options": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "google_ads_options": @@ -4569,38 +5173,56 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: Google Ads specific options for ingestion (object-level). When set, these values override the corresponding fields in GoogleAdsConfig (source_configurations). + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "jira_options": "description": |- Jira specific options for ingestion + "x-databricks-launch-stage": |- + PUBLIC_BETA "kafka_options": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "meta_ads_options": "description": |- Meta Marketing (Meta Ads) specific options for ingestion + "x-databricks-launch-stage": |- + PUBLIC_BETA "outlook_options": "description": |- 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: @@ -4614,6 +5236,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType: CDC - |- QUERY_BASED + "x-databricks-enum-launch-stages": + "CDC": |- + PUBLIC_BETA + "QUERY_BASED": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.CronTrigger: "quartz_cron_schedule": {} "timezone_id": {} @@ -4624,9 +5251,13 @@ github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions: "catalog_name": "description": |- (Required, Immutable) The name of the catalog for the connector's staging storage location. + "x-databricks-launch-stage": |- + PUBLIC_BETA "schema_name": "description": |- (Required, Immutable) The name of the schema for the connector's staging storage location. + "x-databricks-launch-stage": |- + PUBLIC_BETA "volume_name": "description": |- (Optional) The Unity Catalog-compatible name for the storage location. @@ -4634,6 +5265,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions: Spark Declarative Pipelines system will automatically create the volume under the catalog and schema. For Combined Cdc Managed Ingestion pipelines default name for the volume would be : __databricks_ingestion_gateway_staging_data-$pipelineId + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek: "_": "description": |- @@ -4654,6 +5287,21 @@ github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek: SATURDAY - |- SUNDAY + "x-databricks-enum-launch-stages": + "FRIDAY": |- + PUBLIC_PREVIEW + "MONDAY": |- + PUBLIC_PREVIEW + "SATURDAY": |- + PUBLIC_PREVIEW + "SUNDAY": |- + PUBLIC_PREVIEW + "THURSDAY": |- + PUBLIC_PREVIEW + "TUESDAY": |- + PUBLIC_PREVIEW + "WEDNESDAY": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.DeploymentKind: "_": "description": |- @@ -4681,6 +5329,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter: Include files with modification times occurring after the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) 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": @@ -4688,61 +5338,87 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter: Include files with modification times occurring before the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) 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: @@ -4764,6 +5440,23 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFi AVRO - |- ORC + "x-databricks-enum-launch-stages": + "AVRO": |- + PRIVATE_PREVIEW + "BINARYFILE": |- + PRIVATE_PREVIEW + "CSV": |- + PRIVATE_PREVIEW + "EXCEL": |- + PRIVATE_PREVIEW + "JSON": |- + PRIVATE_PREVIEW + "ORC": |- + PRIVATE_PREVIEW + "PARQUET": |- + PRIVATE_PREVIEW + "XML": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode: "_": "description": |- @@ -4779,6 +5472,17 @@ github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSc FAIL_ON_NEW_COLUMNS - |- NONE + "x-databricks-enum-launch-stages": + "ADD_NEW_COLUMNS": |- + PRIVATE_PREVIEW + "ADD_NEW_COLUMNS_WITH_TYPE_WIDENING": |- + PRIVATE_PREVIEW + "FAIL_ON_NEW_COLUMNS": |- + PRIVATE_PREVIEW + "NONE": |- + PRIVATE_PREVIEW + "RESCUE": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.FileLibrary: "path": "description": |- @@ -4798,6 +5502,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig: of customer accounts during source selection. If the same field is also set in the object-level GoogleAdsOptions (connector_options), 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: @@ -4810,6 +5516,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: "description": |- (Optional) Number of days to look back for report tables to capture late-arriving data. If not specified, defaults to 30 days. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "manager_account_id": @@ -4817,6 +5525,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: (Optional at this level) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. Overrides GoogleAdsConfig.manager_account_id from source_configurations when set. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sync_start_date": @@ -4824,18 +5534,26 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. 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: @@ -4847,37 +5565,58 @@ github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoog FILE_METADATA - |- PERMISSION + "x-databricks-enum-launch-stages": + "FILE": |- + PRIVATE_PREVIEW + "FILE_METADATA": |- + PRIVATE_PREVIEW + "PERMISSION": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig: "report": "description": |- Select a specific source report. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "schema": "description": |- Select all tables from a specific source schema. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table": "description": |- Select a specific source table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition: "connection_id": "description": |- [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. "deprecation_message": |- 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": @@ -4885,11 +5624,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipeli Optional. The Unity Catalog-compatible name for the gateway storage location. This is the destination to use for the data that is extracted by the gateway. 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: @@ -4903,43 +5646,61 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin pipeline. Under certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed Ingestion Pipeline with Gateway pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "connector_type": "description": |- (Optional) Connector Type for sources. Ex: CDC, Query Based. + "x-databricks-launch-stage": |- + PUBLIC_BETA "data_staging_options": "description": |- (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline with Gateway pipeline to Combined Cdc Managed Ingestion Pipeline. If not specified, the volume for staged data will be created in catalog and schema/target specified in the top level pipeline definition. + "x-databricks-launch-stage": |- + PUBLIC_BETA "full_refresh_window": "description": |- (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "ingest_from_uc_foreign_catalog": "description": |- Immutable. If set to true, the pipeline will ingest tables from the UC foreign catalogs directly without the need to specify a UC connection or ingestion gateway. The `source_catalog` fields in objects of IngestionConfig are interpreted as the UC foreign catalogs to ingest from. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "ingestion_gateway_id": "description": |- Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. This is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC). Under certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc Managed Ingestion Pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "netsuite_jar_path": "description": |- Netsuite only configuration. When the field is set for a netsuite connector, the jar stored in the field will be validated and added to the classpath of pipeline's cluster. + "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. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_configurations": "description": |- Top-level source configurations + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_type": "description": |- The type of the foreign source. @@ -4947,9 +5708,13 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin This field is output only and will be ignored if provided. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table_configuration": "description": |- Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW ? github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig : "_": "description": |- @@ -4962,6 +5727,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin If the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "deletion_condition": "description": |- Specifies a SQL WHERE condition that specifies that the source row has been deleted. @@ -4971,6 +5738,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin one for soft-deletes and the other for hard-deletes. See also the hard_deletion_sync_min_interval_in_seconds field for handling of "hard deletes" where the source rows are physically removed from the table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "hard_deletion_sync_min_interval_in_seconds": "description": |- Specifies the minimum interval (in seconds) between snapshots on primary keys @@ -4981,6 +5750,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin frequency instead of happening more often. If not set, hard deletion synchronization via snapshots is disabled. This field is mutable and can be updated without triggering a full snapshot. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters: "incremental": "description": |- @@ -4989,6 +5760,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin controlled by the `parameters` field. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "parameters": @@ -5000,6 +5773,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin "start_date": "{ coalesce(current_offset(), date(\"2025-02-01\")) }", "end_date": "{ current_date() - INTERVAL 1 DAY }" } + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "report_parameters": @@ -5008,12 +5783,16 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin This field is deprecated and should not be used. Use `parameters` instead. "deprecation_message": |- 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": @@ -5023,6 +5802,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin 1. coalesce(current_offset(), date("YYYY-MM-DD")) -> if current_offset() is null, then the passed date, else current_offset() 2. current_date() 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: @@ -5068,6 +5849,47 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: ZENDESK - |- FOREIGN_CATALOG + "x-databricks-enum-launch-stages": + "BIGQUERY": |- + PUBLIC_PREVIEW + "CONFLUENCE": |- + PUBLIC_PREVIEW + "DYNAMICS365": |- + PUBLIC_PREVIEW + "FOREIGN_CATALOG": |- + PRIVATE_PREVIEW + "GA4_RAW_DATA": |- + PUBLIC_PREVIEW + "GOOGLE_DRIVE": |- + PRIVATE_PREVIEW + "JIRA": |- + PUBLIC_BETA + "MANAGED_POSTGRESQL": |- + PUBLIC_PREVIEW + "META_MARKETING": |- + PUBLIC_BETA + "MYSQL": |- + PUBLIC_PREVIEW + "NETSUITE": |- + PUBLIC_PREVIEW + "ORACLE": |- + PUBLIC_PREVIEW + "POSTGRESQL": |- + PUBLIC_PREVIEW + "SALESFORCE": |- + PUBLIC_PREVIEW + "SERVICENOW": |- + PUBLIC_PREVIEW + "SHAREPOINT": |- + PUBLIC_PREVIEW + "SQLSERVER": |- + PUBLIC_PREVIEW + "TERADATA": |- + PUBLIC_PREVIEW + "WORKDAY_RAAS": |- + PUBLIC_PREVIEW + "ZENDESK": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions: "_": "description": |- @@ -5075,30 +5897,42 @@ github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions: "include_jira_spaces": "description": |- (Optional) Projects to filter Jira data on + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions: "as_variant": "description": |- 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: @@ -5107,41 +5941,55 @@ github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions: Undocumented backdoor mechanism for overriding parameters to pass to the Kafka client. 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: {} @@ -5152,29 +6000,45 @@ github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions: "action_attribution_windows": "description": |- (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") + "x-databricks-launch-stage": |- + PUBLIC_BETA "action_breakdowns": "description": |- (Optional) Action breakdowns to configure for data aggregation + "x-databricks-launch-stage": |- + PUBLIC_BETA "action_report_time": "description": |- (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) + "x-databricks-launch-stage": |- + PUBLIC_BETA "breakdowns": "description": |- (Optional) Breakdowns to configure for data aggregation + "x-databricks-launch-stage": |- + PUBLIC_BETA "custom_insights_lookback_window": "description": |- (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. + "x-databricks-launch-stage": |- + PUBLIC_BETA "level": "description": |- (Optional) Granularity of data to pull (account, ad, adset, campaign) + "x-databricks-launch-stage": |- + PUBLIC_BETA "start_date": "description": |- (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested + "x-databricks-launch-stage": |- + PUBLIC_BETA "time_increment": "description": |- (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/pipelines.NotebookLibrary: "path": "description": |- @@ -5200,13 +6064,19 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow: "description": |- Days of week in which the window is allowed to happen If not specified all days of the week will be used. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "start_hour": "description": |- An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "time_zone_id": "description": |- Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode: "_": "description": |- @@ -5220,6 +6090,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode: INLINE_ONLY - |- NONE + "x-databricks-enum-launch-stages": + "ALL": |- + PRIVATE_PREVIEW + "INLINE_ONLY": |- + PRIVATE_PREVIEW + "NONE": |- + PRIVATE_PREVIEW + "NON_INLINE_ONLY": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat: "_": "description": |- @@ -5229,6 +6108,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat: TEXT_HTML - |- TEXT_PLAIN + "x-databricks-enum-launch-stages": + "TEXT_HTML": |- + PRIVATE_PREVIEW + "TEXT_PLAIN": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: "_": "description": |- @@ -5237,6 +6121,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: "description": |- (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "body_format": @@ -5244,6 +6130,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: (Optional) Defines how the body_content column is populated. TEXT_HTML: Preserves full formatting, links, and styling. 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": @@ -5251,6 +6139,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Deprecated. Use include_folders instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "include_folders": @@ -5259,6 +6149,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: If not specified, all folders will be synced. Examples: Inbox, Sent Items, Custom_Folder Filter semantics: OR between different folders. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "include_mailboxes": @@ -5266,6 +6158,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). If not specified, all accessible mailboxes are ingested. Filter semantics: OR between different mailboxes. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "include_senders": @@ -5274,6 +6168,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Examples: user@vendor.com, alerts@system.io, noreply@company.com If not specified, emails from all senders will be synced. Filter semantics: OR between different senders. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "include_subjects": @@ -5283,6 +6179,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Examples: "Invoice" (substring), "Re:*" (prefix), "Support Ticket", "URGENT*" If not specified, emails with all subjects will be synced. Filter semantics: OR between different subjects. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "sender_filter": @@ -5290,6 +6188,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Deprecated. Use include_senders instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "start_date": @@ -5298,6 +6198,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Format: YYYY-MM-DD (e.g., 2024-01-01) This determines the earliest date from which to sync historical data. If not specified, complete history is ingested. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "subject_filter": @@ -5305,12 +6207,16 @@ github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions: Deprecated. Use include_subjects instead. "deprecation_message": |- 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": |- The source code to include for pipelines + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.PipelineCluster: "apply_policy_default_values": "description": |- @@ -5443,6 +6349,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineDeployment: ID of the deployment that manages this pipeline. Only set when `kind` is `BUNDLE`. Used to look up deployment metadata from the Deployment Metadata service. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "kind": @@ -5456,6 +6364,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineDeployment: ID of the version of the deployment that produced this pipeline. Only set when `kind` is `BUNDLE`. Identifies a specific snapshot of the 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: @@ -5467,14 +6377,20 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary: The unified field to include source codes. Each entry can be a notebook path, a file path, or a folder path that ends `/**`. This field cannot be used together with `notebook` or `file`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "jar": "description": |- 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": @@ -5511,6 +6427,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment: List of pip dependencies, as supported by the version of pip in this environment. Each dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/ Allowed dependency could be , , (WSFS or Volumes in Databricks), + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "environment_version": "description": |- The environment version of the serverless Python environment used to execute @@ -5523,6 +6441,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment: https://docs.databricks.com/aws/en/release-notes/serverless/environment-version/ 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: @@ -5532,6 +6452,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig: "slot_config": "description": |- Optional. The Postgres slot configuration to use for logical replication + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig: "_": "description": |- @@ -5539,42 +6461,62 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig: "publication_name": "description": |- The name of the publication to use for the Postgres source + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "slot_name": "description": |- The name of the logical replication slot to use for the Postgres source + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec: "destination_catalog": "description": |- Required. Destination catalog to store table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_schema": "description": |- Required. Destination schema to store table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_table": "description": |- Required. Destination table name. The pipeline fails if a table with that name already exists. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_url": "description": |- Required. Report URL in the source system. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table_configuration": "description": |- Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow: "days_of_week": "description": |- Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). 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: @@ -5593,36 +6535,54 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec: "connector_options": "description": |- (Optional) Source Specific Connector Options + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_catalog": "description": |- Required. Destination catalog to store tables. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_schema": "description": |- Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_catalog": "description": |- The source catalog name. Might be optional depending on the type of source. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_schema": "description": |- Required. Schema name in the source database. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table_configuration": "description": |- Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions: "entity_type": "description": |- (Optional) The type of SharePoint entity to ingest. 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: @@ -5636,6 +6596,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsShare PERMISSION - |- LIST + "x-databricks-enum-launch-stages": + "FILE": |- + PRIVATE_PREVIEW + "FILE_METADATA": |- + PRIVATE_PREVIEW + "LIST": |- + PRIVATE_PREVIEW + "PERMISSION": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions: "_": "description": |- @@ -5647,6 +6616,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions: When false, all columns land as STRING. Use false for sheets with irregular data or columns that frequently violate their own declared type. 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: @@ -5656,41 +6627,65 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig: "postgres": "description": |- Postgres-specific catalog-level configuration parameters + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_catalog": "description": |- Source catalog name + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig: "catalog": "description": |- Catalog-level source configuration parameters + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "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": |- (Optional) Source Specific Connector Options + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_catalog": "description": |- Required. Destination catalog to store table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_schema": "description": |- Required. Destination schema to store table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "destination_table": "description": |- Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_catalog": "description": |- Source catalog name. Might be optional depending on the type of source. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_schema": "description": |- Schema name in the source database. Might be optional depending on the type of source. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source_table": "description": |- Required. Table name in the source database. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "table_configuration": "description": |- Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: "auto_full_refresh_policy": "description": |- @@ -5705,12 +6700,16 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: } } If unspecified, auto full refresh is disabled. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "exclude_columns": "description": |- A list of column names to be excluded for the ingestion. When not specified, include_columns fully controls what columns to be ingested. When specified, all other columns including future ones will be automatically included for ingestion. This field in mutually exclusive with `include_columns`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "include_columns": "description": |- A list of column names to be included for the ingestion. @@ -5718,31 +6717,47 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: columns will be automatically included. When specified, all other future columns will be automatically excluded from ingestion. This field in mutually exclusive with `exclude_columns`. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "primary_keys": "description": |- The primary key of the table used to apply changes. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "query_based_connector_config": "description": |- Configurations that are only applicable for query-based ingestion connectors. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "row_filter": "description": |- (Optional, Immutable) The row filter condition to be applied to the table. It must not contain the WHERE keyword, only the actual filter condition. It must be in DBSQL format. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "salesforce_include_formula_fields": "description": |- If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "scd_type": "description": |- The SCD type to use to ingest the table. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "sequence_by": "description": |- The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "workday_report_parameters": "description": |- (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: @@ -5756,6 +6771,13 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScd SCD_TYPE_2 - |- APPEND_ONLY + "x-databricks-enum-launch-stages": + "APPEND_ONLY": |- + PUBLIC_PREVIEW + "SCD_TYPE_1": |- + PUBLIC_PREVIEW + "SCD_TYPE_2": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: "_": "description": |- @@ -5764,6 +6786,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: "description": |- (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "dimensions": @@ -5771,6 +6795,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: (Optional) Dimensions to include in the report. Examples: "campaign_id", "adgroup_id", "ad_id", "stat_time_day", "stat_time_hour" If not specified, defaults to campaign_id. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "lookback_window_days": @@ -5778,6 +6804,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: (Optional) Number of days to look back for report tables during incremental sync to capture late-arriving conversions and attribution data. If not specified, defaults to 7 days. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "metrics": @@ -5785,6 +6813,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: (Optional) Metrics to include in the report. Examples: "spend", "impressions", "clicks", "conversion", "cpc" If not specified, defaults to basic metrics (spend, impressions, clicks, etc.) + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "query_lifetime": @@ -5792,12 +6822,16 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: (Optional) Whether to request lifetime metrics (all-time aggregated data). When true, the report returns all-time data. 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": @@ -5806,6 +6840,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions: This determines the earliest date from which to sync historical data. If not specified, defaults to 1 year of historical data for daily reports 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: @@ -5821,6 +6857,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTok AUCTION_ADGROUP - |- AUCTION_AD + "x-databricks-enum-launch-stages": + "AUCTION_AD": |- + PRIVATE_PREVIEW + "AUCTION_ADGROUP": |- + PRIVATE_PREVIEW + "AUCTION_ADVERTISER": |- + PRIVATE_PREVIEW + "AUCTION_CAMPAIGN": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType: "_": "description": |- @@ -5838,6 +6883,19 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTok BUSINESS_CENTER - |- GMV_MAX + "x-databricks-enum-launch-stages": + "AUDIENCE": |- + PRIVATE_PREVIEW + "BASIC": |- + PRIVATE_PREVIEW + "BUSINESS_CENTER": |- + PRIVATE_PREVIEW + "DSA": |- + PRIVATE_PREVIEW + "GMV_MAX": |- + PRIVATE_PREVIEW + "PLAYABLE_AD": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.Transformer: "_": "description": |- @@ -5845,9 +6903,13 @@ github.com/databricks/databricks-sdk-go/service/pipelines.Transformer: "format": "description": |- 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: @@ -5857,6 +6919,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat: STRING - |- JSON + "x-databricks-enum-launch-stages": + "JSON": |- + PRIVATE_PREVIEW + "STRING": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions: "_": "description": |- @@ -5865,6 +6932,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions: "description": |- (Optional) Start date in YYYY-MM-DD format for the initial sync. 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: @@ -5872,15 +6941,21 @@ github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec: "description": |- Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where size.max > 1. + "x-databricks-launch-stage": |- + PUBLIC_BETA "max": "description": |- The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec. + "x-databricks-launch-stage": |- + PUBLIC_BETA "min": "description": |- The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings: "_": "description": |- @@ -5888,6 +6963,8 @@ github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings: "pg_settings": "description": |- A raw representation of Postgres settings. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.EndpointType: "_": "description": |- @@ -5897,25 +6974,40 @@ github.com/databricks/databricks-sdk-go/service/postgres.EndpointType: ENDPOINT_TYPE_READ_WRITE - |- ENDPOINT_TYPE_READ_ONLY + "x-databricks-enum-launch-stages": + "ENDPOINT_TYPE_READ_ONLY": |- + PUBLIC_BETA + "ENDPOINT_TYPE_READ_WRITE": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.NewPipelineSpec: "budget_policy_id": "description": |- Budget policy to set on the newly created pipeline. + "x-databricks-launch-stage": |- + PUBLIC_BETA "storage_catalog": "description": |- UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables. + "x-databricks-launch-stage": |- + PUBLIC_BETA "storage_schema": "description": |- UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.ProjectCustomTag: "key": "description": |- The key of the custom tag. + "x-databricks-launch-stage": |- + PUBLIC_BETA "value": "description": |- The value of the custom tag. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.ProjectDefaultEndpointSettings: "_": "description": |- @@ -5923,22 +7015,32 @@ github.com/databricks/databricks-sdk-go/service/postgres.ProjectDefaultEndpointS "autoscaling_limit_max_cu": "description": |- The maximum number of Compute Units. Minimum value is 0.5. + "x-databricks-launch-stage": |- + PUBLIC_BETA "autoscaling_limit_min_cu": "description": |- The minimum number of Compute Units. Minimum value is 0.5. + "x-databricks-launch-stage": |- + PUBLIC_BETA "no_suspension": "description": |- When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask. + "x-databricks-launch-stage": |- + PUBLIC_BETA "pg_settings": "description": |- A raw representation of Postgres settings. + "x-databricks-launch-stage": |- + PUBLIC_BETA "suspend_timeout_duration": "description": |- Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy: "_": "description": |- @@ -5950,6 +7052,13 @@ github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableS TRIGGERED - |- SNAPSHOT + "x-databricks-enum-launch-stages": + "CONTINUOUS": |- + PUBLIC_BETA + "SNAPSHOT": |- + PUBLIC_BETA + "TRIGGERED": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/serving.Ai21LabsConfig: "ai21labs_api_key": "description": |- @@ -5971,6 +7080,8 @@ github.com/databricks/databricks-sdk-go/service/serving.AiGatewayConfig: "guardrails": "description": |- Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "inference_table_config": "description": |- Configuration for payload logging using inference tables. @@ -5989,22 +7100,32 @@ github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParame AI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "pii": "description": |- Configuration for guardrail PII filter. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "safety": "description": |- Indicates whether the safety filter is enabled. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "valid_topics": "description": |- The list of allowed topics. Given a chat request, this guardrail flags the request if its topic is not in the allowed topics. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior: "behavior": "description": |- Configuration for input guardrail filters. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior: "_": "enum": @@ -6014,13 +7135,24 @@ github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBeh BLOCK - |- MASK + "x-databricks-enum-launch-stages": + "BLOCK": |- + PUBLIC_PREVIEW + "MASK": |- + PUBLIC_PREVIEW + "NONE": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails: "input": "description": |- Configuration for input guardrail filters. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "output": "description": |- Configuration for output guardrail filters. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayInferenceTableConfig: "catalog_name": "description": |- @@ -6065,11 +7197,23 @@ github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitKey: user_group - |- service_principal + "x-databricks-enum-launch-stages": + "endpoint": |- + PUBLIC_PREVIEW + "service_principal": |- + PUBLIC_PREVIEW + "user": |- + PUBLIC_PREVIEW + "user_group": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayRateLimitRenewalPeriod: "_": "enum": - |- minute + "x-databricks-enum-launch-stages": + "minute": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AiGatewayUsageTrackingConfig: "enabled": "description": |- @@ -6129,6 +7273,15 @@ github.com/databricks/databricks-sdk-go/service/serving.AmazonBedrockConfigBedro ai21labs - |- amazon + "x-databricks-enum-launch-stages": + "ai21labs": |- + PUBLIC_PREVIEW + "amazon": |- + PUBLIC_PREVIEW + "anthropic": |- + PUBLIC_PREVIEW + "cohere": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.AnthropicConfig: "anthropic_api_key": "description": |- @@ -6323,6 +7476,25 @@ github.com/databricks/databricks-sdk-go/service/serving.ExternalModelProvider: palm - |- custom + "x-databricks-enum-launch-stages": + "ai21labs": |- + PUBLIC_PREVIEW + "amazon-bedrock": |- + PUBLIC_PREVIEW + "anthropic": |- + PUBLIC_PREVIEW + "cohere": |- + PUBLIC_PREVIEW + "custom": |- + PUBLIC_PREVIEW + "databricks-model-serving": |- + PUBLIC_PREVIEW + "google-cloud-vertex-ai": |- + PUBLIC_PREVIEW + "openai": |- + PUBLIC_PREVIEW + "palm": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.FallbackConfig: "enabled": "description": |- @@ -6458,11 +7630,19 @@ github.com/databricks/databricks-sdk-go/service/serving.RateLimitKey: user - |- endpoint + "x-databricks-enum-launch-stages": + "endpoint": |- + PUBLIC_PREVIEW + "user": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.RateLimitRenewalPeriod: "_": "enum": - |- minute + "x-databricks-enum-launch-stages": + "minute": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/serving.Route: "served_entity_name": {} "served_model_name": @@ -6477,6 +7657,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput: Whether burst scaling is enabled. When enabled (default), the endpoint can automatically scale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint maintains fixed capacity at provisioned_model_units. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "entity_name": "description": |- The name of the entity to be served. The entity may be a model in the Databricks Model Registry, a model in the Unity Catalog (UC), or a function of type FEATURE_SPEC in the UC. If it is a UC object, the full name of the object should be given in the form of **catalog_name.schema_name.model_name**. @@ -6490,6 +7672,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput: "instance_profile_arn": "description": |- ARN of the instance profile that the served entity uses to access AWS resources. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "max_provisioned_concurrency": "description": |- The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified. @@ -6508,6 +7692,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput: "provisioned_model_units": "description": |- The number of model units provisioned. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "scale_to_zero_enabled": "description": |- Whether the compute resources for the served entity should scale down to zero. @@ -6523,12 +7709,16 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput: Whether burst scaling is enabled. When enabled (default), the endpoint can automatically scale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint maintains fixed capacity at provisioned_model_units. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "environment_vars": "description": |- An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and subject to change. Example entity environment variables that refer to Databricks secrets: `{"OPENAI_API_KEY": "{{secrets/my_scope/my_key}}", "DATABRICKS_TOKEN": "{{secrets/my_scope2/my_key2}}"}` "instance_profile_arn": "description": |- ARN of the instance profile that the served entity uses to access AWS resources. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "max_provisioned_concurrency": "description": |- The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified. @@ -6549,6 +7739,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput: "provisioned_model_units": "description": |- The number of model units provisioned. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "scale_to_zero_enabled": "description": |- Whether the compute resources for the served entity should scale down to zero. @@ -6575,6 +7767,9 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInputWorkload MULTIGPU_MEDIUM - |- GPU_XLARGE + "x-databricks-enum-launch-stages": + "GPU_XLARGE": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/serving.ServingEndpointPermissionLevel: "_": "description": |- @@ -6603,6 +7798,9 @@ github.com/databricks/databricks-sdk-go/service/serving.ServingModelWorkloadType MULTIGPU_MEDIUM - |- GPU_XLARGE + "x-databricks-enum-launch-stages": + "GPU_XLARGE": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/serving.TrafficConfig: "routes": "description": |- @@ -6626,6 +7824,23 @@ github.com/databricks/databricks-sdk-go/service/sql.Aggregation: MAX - |- STDDEV + "x-databricks-enum-launch-stages": + "AVG": |- + PUBLIC_PREVIEW + "COUNT": |- + PUBLIC_PREVIEW + "COUNT_DISTINCT": |- + PUBLIC_PREVIEW + "MAX": |- + PUBLIC_PREVIEW + "MEDIAN": |- + PUBLIC_PREVIEW + "MIN": |- + PUBLIC_PREVIEW + "STDDEV": |- + PUBLIC_PREVIEW + "SUM": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState: "_": "description": |- @@ -6643,6 +7858,15 @@ github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState: OK - |- ERROR + "x-databricks-enum-launch-stages": + "ERROR": |- + PUBLIC_PREVIEW + "OK": |- + PUBLIC_PREVIEW + "TRIGGERED": |- + PUBLIC_PREVIEW + "UNKNOWN": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertLifecycleState: "_": "enum": @@ -6650,65 +7874,114 @@ github.com/databricks/databricks-sdk-go/service/sql.AlertLifecycleState: ACTIVE - |- DELETED + "x-databricks-enum-launch-stages": + "ACTIVE": |- + PUBLIC_PREVIEW + "DELETED": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation: "comparison_operator": "description": |- Operator used for comparison in alert evaluation. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "empty_result_state": "description": |- Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "last_evaluated_at": "description": |- Timestamp of the last evaluation. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "notification": "description": |- User or Notification Destination to notify when alert is triggered. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "source": "description": |- Source column from result to use to evaluate alert + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "state": "description": |- Latest state of alert evaluation. "x-databricks-field-behaviors_output_only": |- true + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "threshold": "description": |- Threshold to user for alert evaluation, can be a column or a value. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2Notification: "notify_on_ok": "description": |- Whether to notify alert subscribers when alert returns back to normal. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "retrigger_seconds": "description": |- Number of seconds an alert waits after being triggered before it is allowed to send another notification. If set to 0 or omitted, the alert will not send any further notifications after the first trigger Setting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes. - "subscriptions": {} + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "subscriptions": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2Operand: - "column": {} - "value": {} + "column": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "value": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn: "aggregation": "description": |- If not set, the behavior is equivalent to using `First row` in the UI. - "display": {} - "name": {} + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "display": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "name": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue: - "bool_value": {} - "double_value": {} - "string_value": {} + "bool_value": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "double_value": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "string_value": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs: "service_principal_name": "description": |- Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "user_name": "description": |- The email of an active workspace user. Can only set this field to their own email. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription: - "destination_id": {} - "user_email": {} + "destination_id": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW + "user_email": + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.Channel: "_": "description": |- @@ -6745,6 +8018,23 @@ github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator: IS_NULL - |- IS_NOT_NULL + "x-databricks-enum-launch-stages": + "EQUAL": |- + PUBLIC_PREVIEW + "GREATER_THAN": |- + PUBLIC_PREVIEW + "GREATER_THAN_OR_EQUAL": |- + PUBLIC_PREVIEW + "IS_NOT_NULL": |- + PUBLIC_PREVIEW + "IS_NULL": |- + PUBLIC_PREVIEW + "LESS_THAN": |- + PUBLIC_PREVIEW + "LESS_THAN_OR_EQUAL": |- + PUBLIC_PREVIEW + "NOT_EQUAL": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.CreateWarehouseRequestWarehouseType: "_": "enum": @@ -6758,15 +8048,21 @@ github.com/databricks/databricks-sdk-go/service/sql.CronSchedule: "pause_status": "description": |- Indicate whether this schedule is paused or not. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "quartz_cron_schedule": "description": |- A cron expression using quartz syntax that specifies the schedule for this pipeline. Should use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW "timezone_id": "description": |- A Java timezone id. The schedule will be resolved using this timezone. This will be combined with the quartz_cron_schedule to determine the schedule. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. + "x-databricks-launch-stage": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.EndpointTagPair: "key": {} "value": {} @@ -6779,6 +8075,11 @@ github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus: UNPAUSED - |- PAUSED + "x-databricks-enum-launch-stages": + "PAUSED": |- + PUBLIC_PREVIEW + "UNPAUSED": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/sql.SpotInstancePolicy: "_": "description": |- @@ -6889,6 +8190,9 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType: STORAGE_OPTIMIZED - |- STANDARD + "x-databricks-enum-launch-stages": + "STORAGE_OPTIMIZED": |- + PUBLIC_PREVIEW github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype: "_": "description": |- @@ -6903,6 +8207,20 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype: FULL_TEXT - |- HYBRID + "x-databricks-enum-descriptions": + "FULL_TEXT": |- + An index that uses full-text search without vector embeddings. + "HYBRID": |- + An index that uses vector embeddings for similarity search and hybrid search. + "VECTOR": |- + Not supported. Use `HYBRID` instead. + "x-databricks-enum-launch-stages": + "FULL_TEXT": |- + PUBLIC_BETA + "HYBRID": |- + PUBLIC_BETA + "VECTOR": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/vectorsearch.PipelineType: "_": "description": |- @@ -6914,6 +8232,11 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.PipelineType: TRIGGERED - |- CONTINUOUS + "x-databricks-enum-descriptions": + "CONTINUOUS": |- + If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh. + "TRIGGERED": |- + If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started. github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType: "_": "description": |- @@ -6925,6 +8248,11 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.VectorIndexType: DELTA_SYNC - |- DIRECT_ACCESS + "x-databricks-enum-descriptions": + "DELTA_SYNC": |- + An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes. + "DIRECT_ACCESS": |- + An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates. github.com/databricks/databricks-sdk-go/service/workspace.AzureKeyVaultSecretScopeMetadata: "_": "description": |- diff --git a/bundle/internal/schema/annotations_test.go b/bundle/internal/schema/annotations_test.go index 0e159335967..a3dd0b7b8db 100644 --- a/bundle/internal/schema/annotations_test.go +++ b/bundle/internal/schema/annotations_test.go @@ -2,6 +2,10 @@ package main import ( "testing" + + "github.com/databricks/cli/bundle/internal/annotation" + "github.com/databricks/cli/libs/jsonschema" + "github.com/stretchr/testify/assert" ) func TestConvertLinksToAbsoluteUrl(t *testing.T) { @@ -46,3 +50,121 @@ func TestConvertLinksToAbsoluteUrl(t *testing.T) { } } } + +func TestAssignAnnotationLaunchStage(t *testing.T) { + t.Run("public preview prefixes description and stays suggestible", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "Target QPS for the endpoint.", + LaunchStage: "PUBLIC_PREVIEW", + }) + assert.Equal(t, "[Public Preview] Target QPS for the endpoint.", s.Description) + assert.False(t, s.DoNotSuggest) + }) + + t.Run("public beta prefixes description", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "A field.", + LaunchStage: "PUBLIC_BETA", + }) + assert.Equal(t, "[Beta] A field.", s.Description) + }) + + 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. + 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) + }) + + t.Run("per-enum-value launch stages do not leak into description", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "Type of endpoint.", + Enum: []any{"STORAGE_OPTIMIZED", "STANDARD"}, + EnumLaunchStages: map[string]string{ + "STORAGE_OPTIMIZED": "PUBLIC_PREVIEW", + }, + }) + assert.Equal(t, "Type of endpoint.", s.Description) + assert.Equal(t, []string{"[Public Preview]", ""}, s.EnumDescriptions) + }) +} + +func TestPrefixWithPreviewTagNoDoubleTag(t *testing.T) { + t.Run("empty description becomes the tag", func(t *testing.T) { + assert.Equal(t, "[Public Preview]", prefixWithPreviewTag("", "[Public Preview]")) + }) + + t.Run("normal description is prefixed once", func(t *testing.T) { + assert.Equal(t, "[Public Preview] A field.", prefixWithPreviewTag("A field.", "[Public Preview]")) + }) + + t.Run("description already starting with the tag is left alone", func(t *testing.T) { + got := prefixWithPreviewTag("[Public Preview] Already tagged.", "[Public Preview]") + assert.Equal(t, "[Public Preview] Already tagged.", got) + }) + + t.Run("different tag still prepends even if description has another tag", func(t *testing.T) { + got := prefixWithPreviewTag("[Private Preview] foo", "[Public Preview]") + assert.Equal(t, "[Public Preview] [Private Preview] foo", got) + }) +} + +func TestBuildEnumDescriptions(t *testing.T) { + enum := []any{"STORAGE_OPTIMIZED", "STANDARD"} + + t.Run("combines launch stage and description per value", func(t *testing.T) { + got := buildEnumDescriptions(enum, + map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, + map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "Standard endpoint.", + }, + ) + assert.Equal(t, []string{ + "[Public Preview] Storage-optimized endpoint.", + "Standard endpoint.", + }, got) + }) + + t.Run("launch stage only emits bracketed label", func(t *testing.T) { + got := buildEnumDescriptions(enum, + map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_BETA"}, + nil, + ) + assert.Equal(t, []string{"[Beta]", ""}, got) + }) + + t.Run("description only is preserved verbatim", func(t *testing.T) { + got := buildEnumDescriptions(enum, + nil, + map[string]string{"STORAGE_OPTIMIZED": "Storage-optimized endpoint."}, + ) + assert.Equal(t, []string{"Storage-optimized endpoint.", ""}, got) + }) + + 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"}, + nil, + )) + }) + + 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"}, + nil, + ) + assert.Equal(t, []string{"[Public Preview]", "", "[Beta]"}, got) + }) +} diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 3785bc78624..904e7469b73 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -99,6 +99,49 @@ func previewFromLaunchStage(launchStage string) string { 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 "" + } + return launchStage +} + +// notableEnumLaunchStages keeps only the enum values whose launch stage is +// worth surfacing (i.e. not GA), so the annotation file isn't polluted with a +// stage for every value of a GA enum. Returns nil when nothing remains. +func notableEnumLaunchStages(stages map[string]string) map[string]string { + result := map[string]string{} + for value, stage := range stages { + if ls := normalizeLaunchStage(stage); ls != "" { + result[value] = ls + } + } + if len(result) == 0 { + return nil + } + return result +} + +// nonEmptyEnumDescriptions drops blank per-value descriptions so the annotation +// file stays clean. Returns nil when nothing remains. +func nonEmptyEnumDescriptions(descriptions map[string]string) map[string]string { + result := map[string]string{} + for value, desc := range descriptions { + if desc != "" { + result[value] = desc + } + } + if len(result) == 0 { + return nil + } + return result +} + // enumValues converts the contract's []string enum into the []any the // annotation descriptor carries (its Enum field predates the typed contract). func enumValues(vals []string) []any { @@ -153,16 +196,22 @@ func (p *annotationParser) extractAnnotations(typ reflect.Type, outputPath, over annotations[basePath] = pkg // The contract carries no schema-level launch stage, so a type is // never itself marked private-preview — only its fields are (below). - if ref.Description != "" || ref.Enum != nil { + // Enum schemas do carry per-value launch stages and descriptions. + enumLaunchStages := notableEnumLaunchStages(ref.EnumLaunchStages) + enumDescriptions := nonEmptyEnumDescriptions(ref.EnumDescriptions) + if ref.Description != "" || ref.Enum != nil || enumLaunchStages != nil || enumDescriptions != nil { pkg[RootTypeKey] = annotation.Descriptor{ - Description: ref.Description, - Enum: enumValues(ref.Enum), + Description: ref.Description, + Enum: enumValues(ref.Enum), + EnumLaunchStages: enumLaunchStages, + EnumDescriptions: enumDescriptions, } } for k := range s.Properties { if refProp, ok := ref.Fields[k]; ok { preview := previewFromLaunchStage(refProp.LaunchStage) + launchStage := normalizeLaunchStage(refProp.LaunchStage) description := refProp.Description @@ -178,6 +227,7 @@ 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), } diff --git a/bundle/internal/schema/parser_test.go b/bundle/internal/schema/parser_test.go new file mode 100644 index 00000000000..a316d622475 --- /dev/null +++ b/bundle/internal/schema/parser_test.go @@ -0,0 +1,67 @@ +package main + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestNormalizeLaunchStage(t *testing.T) { + tests := []struct { + input string + want string + }{ + {"GA", ""}, + {"", ""}, + {"PUBLIC_PREVIEW", "PUBLIC_PREVIEW"}, + {"PUBLIC_BETA", "PUBLIC_BETA"}, + {"PRIVATE_PREVIEW", "PRIVATE_PREVIEW"}, + } + for _, tc := range tests { + assert.Equal(t, tc.want, normalizeLaunchStage(tc.input)) + } +} + +func TestNotableEnumLaunchStages(t *testing.T) { + t.Run("drops GA, keeps preview values", func(t *testing.T) { + got := notableEnumLaunchStages(map[string]string{ + "STORAGE_OPTIMIZED": "PUBLIC_PREVIEW", + "STANDARD": "GA", + }) + assert.Equal(t, map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, got) + }) + + t.Run("returns nil when every value is GA", func(t *testing.T) { + assert.Nil(t, notableEnumLaunchStages(map[string]string{"STANDARD": "GA"})) + }) + + t.Run("returns nil for empty input", func(t *testing.T) { + assert.Nil(t, notableEnumLaunchStages(nil)) + }) +} + +func TestNonEmptyEnumDescriptions(t *testing.T) { + t.Run("keeps non-empty descriptions", func(t *testing.T) { + got := nonEmptyEnumDescriptions(map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "Standard endpoint.", + }) + assert.Equal(t, map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "Standard endpoint.", + }, got) + }) + + t.Run("drops empty descriptions", func(t *testing.T) { + got := nonEmptyEnumDescriptions(map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "", + }) + assert.Equal(t, map[string]string{"STORAGE_OPTIMIZED": "Storage-optimized endpoint."}, got) + }) + + t.Run("returns nil for empty input", func(t *testing.T) { + assert.Nil(t, nonEmptyEnumDescriptions(nil)) + assert.Nil(t, nonEmptyEnumDescriptions(map[string]string{"STANDARD": ""})) + }) +} diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 0ce7f830e47..f88a9389348 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -80,15 +80,19 @@ "type": "object", "properties": { "custom_description": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "custom_summary": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "display_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "evaluation": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation" }, "file_path": { @@ -98,26 +102,32 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "parent_path": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "permissions": { "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" }, "query_text": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "run_as": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs" }, "run_as_user_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "deprecationMessage": "This field is deprecated", "deprecated": true }, "schedule": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule" }, "warehouse_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string" } }, @@ -142,14 +152,17 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "compute_max_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "compute_min_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -191,18 +204,21 @@ "$ref": "#/$defs/string" }, "space": { - "description": "Name of the space this app belongs to.", + "description": "[Private Preview] Name of the space this app belongs to.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "telemetry_export_destinations": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination" }, "usage_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "user_api_scopes": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/string" } }, @@ -608,14 +624,15 @@ "type": "object", "properties": { "create_database_if_not_exists": { + "description": "[Public Preview]", "$ref": "#/$defs/bool" }, "database_instance_name": { - "description": "The name of the DatabaseInstance housing the database.", + "description": "[Public Preview] The name of the DatabaseInstance housing the database.", "$ref": "#/$defs/string" }, "database_name": { - "description": "The name of the database (in a instance) associated with the catalog.", + "description": "[Public Preview] The name of the database (in a instance) associated with the catalog.", "$ref": "#/$defs/string" }, "lifecycle": { @@ -623,7 +640,7 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { - "description": "The name of the catalog in UC.", + "description": "[Public Preview] The name of the catalog in UC.", "$ref": "#/$defs/string" } }, @@ -647,19 +664,19 @@ "description": "A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.", "properties": { "capacity": { - "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "description": "[Public Preview] The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", "$ref": "#/$defs/string" }, "custom_tags": { - "description": "Custom tags associated with the instance. This field is only included on create and update responses.", + "description": "[Beta] Custom tags associated with the instance. This field is only included on create and update responses.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.CustomTag" }, "enable_pg_native_login": { - "description": "Whether to enable PG native password login on the instance. Defaults to false.", + "description": "[Public Preview] Whether to enable PG native password login on the instance. Defaults to false.", "$ref": "#/$defs/bool" }, "enable_readable_secondaries": { - "description": "Whether to enable secondaries to serve read-only traffic. Defaults to false.", + "description": "[Public Preview] Whether to enable secondaries to serve read-only traffic. Defaults to false.", "$ref": "#/$defs/bool" }, "lifecycle": { @@ -667,30 +684,30 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { - "description": "The name of the instance. This is the unique identifier for the instance.", + "description": "[Public Preview] The name of the instance. This is the unique identifier for the instance.", "$ref": "#/$defs/string" }, "node_count": { - "description": "The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see effective_node_count for the output.", + "description": "[Public Preview] The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see effective_node_count for the output.", "$ref": "#/$defs/int" }, "parent_instance_ref": { - "description": "The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", + "description": "[Public Preview] The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef" }, "permissions": { "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" }, "retention_window_in_days": { - "description": "The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days.", + "description": "[Public Preview] The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days.", "$ref": "#/$defs/int" }, "stopped": { - "description": "Whether to stop the instance. An input only param, see effective_stopped for the output.", + "description": "[Public Preview] Whether to stop the instance. An input only param, see effective_stopped for the output.", "$ref": "#/$defs/bool" }, "usage_policy_id": { - "description": "The desired usage policy to associate with the instance.", + "description": "[Beta] The desired usage policy to associate with the instance.", "$ref": "#/$defs/string" } }, @@ -813,7 +830,7 @@ "type": "object", "properties": { "budget_policy_id": { - "description": "The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", + "description": "[Public Preview] The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", "$ref": "#/$defs/string" }, "continuous": { @@ -898,7 +915,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.TriggerSettings" }, "usage_policy_id": { - "description": "The id of the user specified usage policy to use for this job.\nIf not specified, a default usage policy may be applied when creating or modifying the job.\nSee `effective_usage_policy_id` for the usage policy used by this workload.", + "description": "[Private Preview] The id of the user specified usage policy to use for this job.\nIf not specified, a default usage policy may be applied when creating or modifying the job.\nSee `effective_usage_policy_id` for the usage policy used by this workload.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -1252,7 +1269,7 @@ "$ref": "#/$defs/bool" }, "budget_policy_id": { - "description": "Budget policy of this pipeline.", + "description": "[Public Preview] Budget policy of this pipeline.", "$ref": "#/$defs/string" }, "catalog": { @@ -1284,7 +1301,7 @@ "$ref": "#/$defs/string" }, "environment": { - "description": "Environment specification for this pipeline used to install dependencies.", + "description": "[Public Preview] Environment specification for this pipeline used to install dependencies.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment" }, "event_log": { @@ -1296,7 +1313,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Filters" }, "gateway_definition": { - "description": "The definition of a gateway pipeline to support change data capture.", + "description": "[Private Preview] The definition of a gateway pipeline to support change data capture.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -1306,7 +1323,7 @@ "$ref": "#/$defs/string" }, "ingestion_definition": { - "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "description": "[Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition" }, "libraries": { @@ -1326,6 +1343,7 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.Notifications" }, "parameters": { + "description": "[Beta]", "$ref": "#/$defs/map/string" }, "permissions": { @@ -1336,13 +1354,13 @@ "$ref": "#/$defs/bool" }, "restart_window": { - "description": "Restart window of this pipeline.", + "description": "[Private Preview] Restart window of this pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "root_path": { - "description": "Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", + "description": "[Public Preview] Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", "$ref": "#/$defs/string" }, "run_as": { @@ -1377,7 +1395,7 @@ "deprecated": true }, "usage_policy_id": { - "description": "Usage policy of this pipeline.", + "description": "[Private Preview] Usage policy of this pipeline.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -1681,7 +1699,7 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.MonitorMetric" }, "data_classification_config": { - "description": "[Create:OPT Update:OPT] Data classification related config.", + "description": "[Private Preview] [Create:OPT Update:OPT] Data classification related config.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificationConfig", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -2056,18 +2074,22 @@ "type": "object", "properties": { "database_instance_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "lifecycle": { "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "logical_database_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "name": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "spec": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec" } }, @@ -2088,6 +2110,7 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "endpoint_type": { @@ -2103,9 +2126,11 @@ "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" }, "target_qps": { + "description": "[Public Preview]", "$ref": "#/$defs/int64" }, "usage_policy_id": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -2141,6 +2166,7 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment" }, "index_subtype": { + "description": "[Beta]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype" }, "index_type": { @@ -4048,7 +4074,7 @@ "description": "Data classification related configuration.", "properties": { "enabled": { - "description": "Whether to enable data classification.", + "description": "[Private Preview] Whether to enable data classification.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -4213,7 +4239,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination" }, "on_new_classification_tag_detected": { - "description": "Destinations to send notifications on new classification tag detected.", + "description": "[Private Preview] Destinations to send notifications on new classification tag detected.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -4821,6 +4847,10 @@ "enum": [ "CONFIDENTIAL_COMPUTE_TYPE_NONE", "SEV_SNP" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, { @@ -4845,6 +4875,18 @@ "DATA_SECURITY_MODE_STANDARD", "DATA_SECURITY_MODE_DEDICATED", "DATA_SECURITY_MODE_AUTO" + ], + "enumDescriptions": [ + "", + "Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.", + "Legacy alias for `DATA_SECURITY_MODE_STANDARD`.", + "This mode is for users migrating from legacy Table ACL clusters.", + "This mode is for users migrating from legacy Passthrough on high concurrency clusters.", + "This mode is for users migrating from legacy Passthrough on standard clusters.", + "This mode provides a way that doesn’t have UC nor passthrough enabled.", + "A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.", + "A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.", + "\u003cDatabricks\u003e will choose the most appropriate access mode depending on your compute configuration." ] }, { @@ -4959,6 +5001,7 @@ "$ref": "#/$defs/string" }, "java_dependencies": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/string" } }, @@ -4984,7 +5027,7 @@ "$ref": "#/$defs/int" }, "confidential_compute_type": { - "description": "The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", + "description": "[Private Preview] The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ConfidentialComputeType", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -5067,6 +5110,10 @@ "enum": [ "GPU_1xA10", "GPU_8xH100" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, { @@ -5469,11 +5516,11 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", + "description": "[Public Preview] The key of the custom tag.", "$ref": "#/$defs/string" }, "value": { - "description": "The value of the custom tag.", + "description": "[Public Preview] The value of the custom tag.", "$ref": "#/$defs/string" } }, @@ -5492,15 +5539,15 @@ "description": "DatabaseInstanceRef is a reference to a database instance. It is used in the\nDatabaseInstance object to refer to the parent instance of an instance and\nto refer the child instances of an instance.\nTo specify as a parent instance during creation of an instance,\nthe lsn and branch_time fields are optional. If not specified, the child\ninstance will be created from the latest lsn of the parent.\nIf both lsn and branch_time are specified, the lsn will be used to create\nthe child instance.", "properties": { "branch_time": { - "description": "Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", + "description": "[Public Preview] Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", "$ref": "#/$defs/string" }, "lsn": { - "description": "User-specified WAL LSN of the ref database instance.\n\nInput: For specifying the WAL LSN to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", + "description": "[Public Preview] User-specified WAL LSN of the ref database instance.\n\nInput: For specifying the WAL LSN to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", "$ref": "#/$defs/string" }, "name": { - "description": "Name of the ref database instance.", + "description": "[Public Preview] Name of the ref database instance.", "$ref": "#/$defs/string" } }, @@ -5523,6 +5570,14 @@ "STOPPED", "UPDATING", "FAILING_OVER" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -5550,15 +5605,15 @@ "description": "Custom fields that user can set for pipeline while creating SyncedDatabaseTable.\nNote that other fields of pipeline are still inferred by table def internally", "properties": { "budget_policy_id": { - "description": "Budget policy to set on the newly created pipeline.", + "description": "[Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string" }, "storage_catalog": { - "description": "This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", + "description": "[Public Preview] This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string" }, "storage_schema": { - "description": "This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", + "description": "[Public Preview] This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string" } }, @@ -5581,6 +5636,14 @@ "DELETING", "UPDATING", "DEGRADED" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -5597,6 +5660,11 @@ "PROVISIONING_PHASE_MAIN", "PROVISIONING_PHASE_INDEX_SCAN", "PROVISIONING_PHASE_INDEX_SORT" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -5677,6 +5745,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -5692,31 +5765,31 @@ "description": "Specification of a synced database table.", "properties": { "create_database_objects_if_missing": { - "description": "If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.", + "description": "[Public Preview] If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.", "$ref": "#/$defs/bool" }, "existing_pipeline_id": { - "description": "At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline\nreferenced. This avoids creating a new pipeline and allows sharing existing compute.\nIn this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline.", + "description": "[Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline\nreferenced. This avoids creating a new pipeline and allows sharing existing compute.\nIn this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline.", "$ref": "#/$defs/string" }, "new_pipeline_spec": { - "description": "At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used\nto store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta\ntables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table\nonly requires read permissions.", + "description": "[Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used\nto store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta\ntables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table\nonly requires read permissions.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec" }, "primary_key_columns": { - "description": "Primary Key columns to be used for data insert/update in the destination.", + "description": "[Public Preview] Primary Key columns to be used for data insert/update in the destination.", "$ref": "#/$defs/slice/string" }, "scheduling_policy": { - "description": "Scheduling policy of the underlying pipeline.", + "description": "[Public Preview] Scheduling policy of the underlying pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPolicy" }, "source_table_full_name": { - "description": "Three-part (catalog, schema, table) name of the source Delta table.", + "description": "[Public Preview] Three-part (catalog, schema, table) name of the source Delta table.", "$ref": "#/$defs/string" }, "timeseries_key": { - "description": "Time series key to deduplicate (tie-break) rows with the same primary key.", + "description": "[Public Preview] Time series key to deduplicate (tie-break) rows with the same primary key.", "$ref": "#/$defs/string" } }, @@ -5745,6 +5818,19 @@ "SYNCED_TABLE_OFFLINE_FAILED", "SYNCED_TABLE_ONLINE_PIPELINE_FAILED", "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -5760,19 +5846,19 @@ "description": "Status of a synced table.", "properties": { "continuous_update_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE\nor the SYNCED_UPDATING_PIPELINE_RESOURCES state.", + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE\nor the SYNCED_UPDATING_PIPELINE_RESOURCES state.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus" }, "failed_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus" }, "provisioning_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioningStatus" }, "triggered_update_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE\nor the SYNCED_NO_PENDING_UPDATE state.", + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE\nor the SYNCED_NO_PENDING_UPDATE state.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpdateStatus" } }, @@ -5823,6 +5909,28 @@ "CAN_CREATE", "CAN_MONITOR_ONLY", "CAN_CREATE_APP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -5837,19 +5945,19 @@ "type": "object", "properties": { "alert_id": { - "description": "The alert_id is the canonical identifier of the alert.", + "description": "[Public Preview] The alert_id is the canonical identifier of the alert.", "$ref": "#/$defs/string" }, "subscribers": { - "description": "The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", + "description": "[Public Preview] The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber" }, "warehouse_id": { - "description": "The warehouse_id identifies the warehouse settings used by the alert task.", + "description": "[Public Preview] The warehouse_id identifies the warehouse settings used by the alert task.", "$ref": "#/$defs/string" }, "workspace_path": { - "description": "The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", + "description": "[Public Preview] The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", "$ref": "#/$defs/string" } }, @@ -5868,10 +5976,11 @@ "description": "Represents a subscriber that will receive alert notifications.\nA subscriber can be either a user (via email) or a notification destination (via destination_id).", "properties": { "destination_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "user_name": { - "description": "A valid workspace email address.", + "description": "[Public Preview] A valid workspace email address.", "$ref": "#/$defs/string" } }, @@ -5890,6 +5999,10 @@ "enum": [ "OAUTH", "PAT" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, { @@ -5939,7 +6052,7 @@ "type": "object", "properties": { "hardware_accelerator": { - "description": "Hardware accelerator configuration for Serverless GPU workloads.", + "description": "[Beta] Hardware accelerator configuration for Serverless GPU workloads.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType" } }, @@ -5957,19 +6070,19 @@ "type": "object", "properties": { "gpu_node_pool_id": { - "description": "IDof the GPU pool to use.", + "description": "[Private Preview] IDof the GPU pool to use.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "gpu_type": { - "description": "GPU type.", + "description": "[Private Preview] GPU type.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "num_gpus": { - "description": "Number of GPUs.", + "description": "[Private Preview] Number of GPUs.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6114,7 +6227,7 @@ "$ref": "#/$defs/string" }, "filters": { - "description": "Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key.\nThe parameter value format is dependent on the filter type:\n- For text and single-select filters, provide a single value (e.g. `\"value\"`)\n- For date and datetime filters, provide the value in ISO 8601 format (e.g. `\"2000-01-01T00:00:00\"`)\n- For multi-select filters, provide a JSON array of values (e.g. `\"[\\\"value1\\\",\\\"value2\\\"]\"`)\n- For range and date range filters, provide a JSON object with `start` and `end` (e.g. `\"{\\\"start\\\":\\\"1\\\",\\\"end\\\":\\\"10\\\"}\"`)", + "description": "[Private Preview] Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key.\nThe parameter value format is dependent on the filter type:\n- For text and single-select filters, provide a single value (e.g. `\"value\"`)\n- For date and datetime filters, provide the value in ISO 8601 format (e.g. `\"2000-01-01T00:00:00\"`)\n- For multi-select filters, provide a JSON array of values (e.g. `\"[\\\"value1\\\",\\\"value2\\\"]\"`)\n- For range and date range filters, provide a JSON object with `start` and `end` (e.g. `\"{\\\"start\\\":\\\"1\\\",\\\"end\\\":\\\"10\\\"}\"`)", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6142,13 +6255,13 @@ "description": "Deprecated in favor of DbtPlatformTask", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt Cloud for this task", + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt Cloud for this task", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "dbt_cloud_job_id": { - "description": "Id of the dbt Cloud job to be triggered", + "description": "[Private Preview] Id of the dbt Cloud job to be triggered", "$ref": "#/$defs/int64", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6168,13 +6281,13 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt platform for this task", + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "dbt_platform_job_id": { - "description": "Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", + "description": "[Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6313,48 +6426,49 @@ "type": "object", "properties": { "command": { - "description": "Command launcher to run the actual script, e.g. bash, python etc.", + "description": "[Private Preview] Command launcher to run the actual script, e.g. bash, python etc.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "compute": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "dl_runtime_image": { - "description": "Runtime image", + "description": "[Private Preview] Runtime image", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "mlflow_experiment_name": { - "description": "Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", + "description": "[Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "source": { - "description": "Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", + "description": "[Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "training_script_path": { - "description": "The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", + "description": "[Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "yaml_parameters": { - "description": "Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", + "description": "[Private Preview] Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "yaml_parameters_file_path": { - "description": "Optional path to a YAML file containing model parameters passed to the training script.", + "description": "[Private Preview] Optional path to a YAML file containing model parameters passed to the training script.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6485,7 +6599,7 @@ "type": "object", "properties": { "deployment_id": { - "description": "ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "description": "[Private Preview] ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6499,7 +6613,7 @@ "$ref": "#/$defs/string" }, "version_id": { - "description": "ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", + "description": "[Private Preview] ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6524,6 +6638,10 @@ "enum": [ "BUNDLE", "SYSTEM_MANAGED" + ], + "enumDescriptions": [ + "The job is managed by Databricks Asset Bundle.", + "[Beta] The job is managed by \u003cDatabricks\u003e and is read-only." ] }, { @@ -6540,6 +6658,10 @@ "enum": [ "UI_LOCKED", "EDITABLE" + ], + "enumDescriptions": [ + "The job is in a locked UI state and cannot be modified.", + "The job is in an editable state and can be modified." ] }, { @@ -6572,7 +6694,7 @@ "$ref": "#/$defs/slice/string" }, "on_streaming_backlog_exceeded": { - "description": "A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", + "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", "$ref": "#/$defs/slice/string" }, "on_success": { @@ -6685,7 +6807,7 @@ "description": "Write-only setting. Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who created the job.\n\nEither `user_name` or `service_principal_name` should be specified. If not, an error is thrown.", "properties": { "group_name": { - "description": "Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", + "description": "[Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6714,19 +6836,19 @@ "description": "The source of the job specification in the remote repository when the job is source controlled.", "properties": { "dirty_state": { - "description": "Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", + "description": "[Private Preview] Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "import_from_git_branch": { - "description": "Name of the branch which the job is imported from.", + "description": "[Private Preview] Name of the branch which the job is imported from.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "job_config_path": { - "description": "Path of the job YAML file that contains the job specification.", + "description": "[Private Preview] Path of the job YAML file that contains the job specification.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6752,6 +6874,10 @@ "enum": [ "NOT_SYNCED", "DISCONNECTED" + ], + "enumDescriptions": [ + "[Private Preview] The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.", + "[Private Preview] The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced." ] }, { @@ -6771,6 +6897,13 @@ "STREAMING_BACKLOG_RECORDS", "STREAMING_BACKLOG_SECONDS", "STREAMING_BACKLOG_FILES" + ], + "enumDescriptions": [ + "Expected total time for a run in seconds.", + "An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.", + "An estimate of the maximum offset lag across all streams. This metric is in Public Preview.", + "An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.", + "An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview." ] }, { @@ -6847,31 +6980,31 @@ "type": "object", "properties": { "aliases": { - "description": "Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", + "description": "[Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "condition": { - "description": "The condition based on which to trigger a job run.", + "description": "[Private Preview] The condition based on which to trigger a job run.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "min_time_between_triggers_seconds": { - "description": "If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", + "description": "[Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "securable_name": { - "description": "Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", + "description": "[Private Preview] Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "wait_after_last_change_seconds": { - "description": "If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", + "description": "[Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -6896,6 +7029,11 @@ "MODEL_CREATED", "MODEL_VERSION_READY", "MODEL_ALIAS_SET" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -7020,19 +7158,19 @@ "$ref": "#/$defs/bool" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", + "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string" }, "refresh_flow_selection": { - "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", "$ref": "#/$defs/slice/string" }, "refresh_selection": { - "description": "A list of tables to update without fullRefresh.", + "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string" } }, @@ -7054,11 +7192,11 @@ "$ref": "#/$defs/bool" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", + "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string" }, "parameters": { - "description": "Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", + "description": "[Beta] Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", "$ref": "#/$defs/map/string" }, "pipeline_id": { @@ -7066,15 +7204,15 @@ "$ref": "#/$defs/string" }, "refresh_flow_selection": { - "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", "$ref": "#/$defs/slice/string" }, "refresh_selection": { - "description": "A list of tables to update without fullRefresh.", + "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string" } }, @@ -7095,23 +7233,23 @@ "type": "object", "properties": { "authentication_method": { - "description": "How the published Power BI model authenticates to Databricks", + "description": "[Public Preview] How the published Power BI model authenticates to Databricks", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod" }, "model_name": { - "description": "The name of the Power BI model", + "description": "[Public Preview] The name of the Power BI model", "$ref": "#/$defs/string" }, "overwrite_existing": { - "description": "Whether to overwrite existing Power BI models", + "description": "[Public Preview] Whether to overwrite existing Power BI models", "$ref": "#/$defs/bool" }, "storage_mode": { - "description": "The default storage mode of the Power BI model", + "description": "[Public Preview] The default storage mode of the Power BI model", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode" }, "workspace_name": { - "description": "The name of the Power BI workspace of the model", + "description": "[Public Preview] The name of the Power BI workspace of the model", "$ref": "#/$defs/string" } }, @@ -7129,19 +7267,19 @@ "type": "object", "properties": { "catalog": { - "description": "The catalog name in Databricks", + "description": "[Public Preview] The catalog name in Databricks", "$ref": "#/$defs/string" }, "name": { - "description": "The table name in Databricks", + "description": "[Public Preview] The table name in Databricks", "$ref": "#/$defs/string" }, "schema": { - "description": "The schema name in Databricks", + "description": "[Public Preview] The schema name in Databricks", "$ref": "#/$defs/string" }, "storage_mode": { - "description": "The Power BI storage mode of the table", + "description": "[Public Preview] The Power BI storage mode of the table", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode" } }, @@ -7159,23 +7297,23 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection to authenticate from Databricks to Power BI", + "description": "[Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI", "$ref": "#/$defs/string" }, "power_bi_model": { - "description": "The semantic model to update", + "description": "[Public Preview] The semantic model to update", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiModel" }, "refresh_after_update": { - "description": "Whether the model should be refreshed after the update", + "description": "[Public Preview] Whether the model should be refreshed after the update", "$ref": "#/$defs/bool" }, "tables": { - "description": "The tables to be exported to Power BI", + "description": "[Public Preview] The tables to be exported to Power BI", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable" }, "warehouse_id": { - "description": "The SQL warehouse ID to use as the Power BI data source", + "description": "[Public Preview] The SQL warehouse ID to use as the Power BI data source", "$ref": "#/$defs/string" } }, @@ -7193,13 +7331,13 @@ "type": "object", "properties": { "main": { - "description": "Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", + "description": "[Private Preview] Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "parameters": { - "description": "An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", + "description": "[Private Preview] An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -7219,11 +7357,13 @@ "type": "object", "properties": { "name": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "value": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -7304,6 +7444,14 @@ "AT_LEAST_ONE_SUCCESS", "ALL_FAILED", "AT_LEAST_ONE_FAILED" + ], + "enumDescriptions": [ + "All dependencies have executed and succeeded", + "All dependencies have been completed", + "None of the dependencies have failed and at least one was executed", + "At least one dependency has succeeded", + "ALl dependencies have failed", + "At least one dependency failed" ] }, { @@ -7318,7 +7466,7 @@ "type": "object", "properties": { "dbt_commands": { - "description": "An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7326,7 +7474,7 @@ "deprecated": true }, "jar_params": { - "description": "A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7342,7 +7490,7 @@ "$ref": "#/$defs/map/string" }, "notebook_params": { - "description": "A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.", + "description": "[Private Preview] A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7354,6 +7502,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineParams" }, "python_named_params": { + "description": "[Private Preview]", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7361,7 +7510,7 @@ "deprecated": true }, "python_params": { - "description": "A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", + "description": "[Private Preview] A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7369,7 +7518,7 @@ "deprecated": true }, "spark_submit_params": { - "description": "A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", + "description": "[Private Preview] A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7377,7 +7526,7 @@ "deprecated": true }, "sql_params": { - "description": "A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7404,6 +7553,10 @@ "enum": [ "WORKSPACE", "GIT" + ], + "enumDescriptions": [ + "SQL file is located in \u003cDatabricks\u003e workspace.", + "SQL file is located in cloud Git provider." ] }, { @@ -7690,6 +7843,11 @@ "DIRECT_QUERY", "IMPORT", "DUAL" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -7782,7 +7940,7 @@ "type": "object", "properties": { "alert_task": { - "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", + "description": "[Public Preview] The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask" }, "clean_rooms_notebook_task": { @@ -7790,7 +7948,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CleanRoomsNotebookTask" }, "compute": { - "description": "Task level compute configuration.", + "description": "[Beta] Task level compute configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute" }, "condition_task": { @@ -7802,7 +7960,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DashboardTask" }, "dbt_cloud_task": { - "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", + "description": "[Private Preview] Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtCloudTask", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7810,6 +7968,7 @@ "deprecated": true }, "dbt_platform_task": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -7851,6 +8010,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ForEachTask" }, "gen_ai_compute_task": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -7891,11 +8051,11 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PipelineTask" }, "power_bi_task": { - "description": "The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", + "description": "[Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask" }, "python_operator_task": { - "description": "The task runs a Python operator task.", + "description": "[Private Preview] The task runs a Python operator task.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8007,7 +8167,7 @@ "$ref": "#/$defs/slice/string" }, "on_streaming_backlog_exceeded": { - "description": "A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", + "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", "$ref": "#/$defs/slice/string" }, "on_success": { @@ -8075,6 +8235,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.FileArrivalTriggerConfiguration" }, "model": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8137,7 +8298,7 @@ "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook" }, "on_streaming_backlog_exceeded": { - "description": "An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property.", + "description": "[Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook" }, "on_success": { @@ -8242,11 +8403,11 @@ "description": "Policy for auto full refresh.", "properties": { "enabled": { - "description": "(Required, Mutable) Whether to enable auto full refresh or not.", + "description": "[Public Preview] (Required, Mutable) Whether to enable auto full refresh or not.", "$ref": "#/$defs/bool" }, "min_interval_hours": { - "description": "(Optional, Mutable) Specify the minimum interval in hours between the timestamp\nat which a table was last full refreshed and the current timestamp for triggering auto full\nIf unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours.", + "description": "[Public Preview] (Optional, Mutable) Specify the minimum interval in hours between the timestamp\nat which a table was last full refreshed and the current timestamp for triggering auto full\nIf unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours.", "$ref": "#/$defs/int" } }, @@ -8268,7 +8429,7 @@ "description": "Confluence specific options for ingestion", "properties": { "include_confluence_spaces": { - "description": "(Optional) Spaces to filter Confluence data on", + "description": "[Public Preview] (Optional) Spaces to filter Confluence data on", "$ref": "#/$defs/slice/string" } }, @@ -8286,7 +8447,7 @@ "type": "object", "properties": { "source_catalog": { - "description": "Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", + "description": "[Private Preview] Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8307,58 +8468,61 @@ "description": "Wrapper message for source-specific options to support multiple connector types", "properties": { "confluence_options": { - "description": "Confluence specific options for ingestion", + "description": "[Public Preview] Confluence specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions" }, "gdrive_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "google_ads_options": { - "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", + "description": "[Private Preview] Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "jira_options": { - "description": "Jira specific options for ingestion", + "description": "[Beta] Jira specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions" }, "kafka_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "meta_ads_options": { - "description": "Meta Marketing (Meta Ads) specific options for ingestion", + "description": "[Beta] Meta Marketing (Meta Ads) specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions" }, "outlook_options": { - "description": "Outlook specific options for ingestion", + "description": "[Private Preview] Outlook specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "sharepoint_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "smartsheet_options": { - "description": "Smartsheet specific options for ingestion", + "description": "[Private Preview] Smartsheet specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "tiktok_ads_options": { - "description": "TikTok Ads specific options for ingestion", + "description": "[Private Preview] TikTok Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "zendesk_support_options": { - "description": "Zendesk Support specific options for ingestion", + "description": "[Private Preview] Zendesk Support specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8380,6 +8544,10 @@ "enum": [ "CDC", "QUERY_BASED" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, { @@ -8415,15 +8583,15 @@ "description": "Location of staged data storage", "properties": { "catalog_name": { - "description": "(Required, Immutable) The name of the catalog for the connector's staging storage location.", + "description": "[Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location.", "$ref": "#/$defs/string" }, "schema_name": { - "description": "(Required, Immutable) The name of the schema for the connector's staging storage location.", + "description": "[Beta] (Required, Immutable) The name of the schema for the connector's staging storage location.", "$ref": "#/$defs/string" }, "volume_name": { - "description": "(Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", + "description": "[Beta] (Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", "$ref": "#/$defs/string" } }, @@ -8452,6 +8620,15 @@ "FRIDAY", "SATURDAY", "SUNDAY" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -8508,19 +8685,19 @@ "type": "object", "properties": { "modified_after": { - "description": "Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", + "description": "[Private Preview] Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "modified_before": { - "description": "Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", + "description": "[Private Preview] Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "path_filter": { - "description": "Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", + "description": "[Private Preview] Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8540,62 +8717,67 @@ "type": "object", "properties": { "corrupt_record_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "file_filters": { - "description": "Generic options", + "description": "[Private Preview] Generic options", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "format": { - "description": "required for TableSpec", + "description": "[Private Preview] required for TableSpec", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "format_options": { - "description": "Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", + "description": "[Private Preview] Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "ignore_corrupt_files": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "infer_column_types": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "reader_case_sensitive": { - "description": "Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", + "description": "[Private Preview] Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "rescued_data_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "schema_evolution_mode": { - "description": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", + "description": "[Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "schema_hints": { - "description": "Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", + "description": "[Private Preview] Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "single_variant_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8622,6 +8804,16 @@ "PARQUET", "AVRO", "ORC" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -8641,6 +8833,13 @@ "RESCUE", "FAIL_ON_NEW_COLUMNS", "NONE" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -8695,7 +8894,7 @@ "type": "object", "properties": { "manager_account_id": { - "description": "(Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", + "description": "[Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8716,19 +8915,19 @@ "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "properties": { "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", + "description": "[Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "manager_account_id": { - "description": "(Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", + "description": "[Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8751,17 +8950,19 @@ "type": "object", "properties": { "entity_type": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "file_ingestion_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "url": { - "description": "Google Drive URL.", + "description": "[Private Preview] Google Drive URL.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8783,6 +8984,11 @@ "FILE", "FILE_METADATA", "PERMISSION" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -8797,15 +9003,15 @@ "type": "object", "properties": { "report": { - "description": "Select a specific source report.", + "description": "[Public Preview] Select a specific source report.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec" }, "schema": { - "description": "Select all tables from a specific source schema.", + "description": "[Public Preview] Select all tables from a specific source schema.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec" }, "table": { - "description": "Select a specific source table.", + "description": "[Public Preview] Select a specific source table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec" } }, @@ -8823,7 +9029,7 @@ "type": "object", "properties": { "connection_id": { - "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "description": "[Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -8831,31 +9037,31 @@ "deprecated": true }, "connection_name": { - "description": "Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "description": "[Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "connection_parameters": { - "description": "Optional, Internal. Parameters required to establish an initial connection with the source.", + "description": "[Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "gateway_storage_catalog": { - "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", + "description": "[Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "gateway_storage_name": { - "description": "Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", + "description": "[Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "gateway_storage_schema": { - "description": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.", + "description": "[Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -8880,44 +9086,45 @@ "type": "object", "properties": { "connection_name": { - "description": "The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with\nboth connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle,\n(connector_type = QUERY_BASED OR connector_type = CDC).\nIf connection name corresponds to database connectors like Oracle, and connector_type is not provided then\nconnector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion\npipeline.\nUnder certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed\nIngestion Pipeline with Gateway pipeline.", + "description": "[Public Preview] The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with\nboth connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle,\n(connector_type = QUERY_BASED OR connector_type = CDC).\nIf connection name corresponds to database connectors like Oracle, and connector_type is not provided then\nconnector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion\npipeline.\nUnder certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed\nIngestion Pipeline with Gateway pipeline.", "$ref": "#/$defs/string" }, "connector_type": { - "description": "(Optional) Connector Type for sources. Ex: CDC, Query Based.", + "description": "[Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType" }, "data_staging_options": { - "description": "(Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", + "description": "[Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions" }, "full_refresh_window": { - "description": "(Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", + "description": "[Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow" }, "ingest_from_uc_foreign_catalog": { - "description": "Immutable. If set to true, the pipeline will ingest tables from the\nUC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.\nThe `source_catalog` fields in objects of IngestionConfig are interpreted as\nthe UC foreign catalogs to ingest from.", + "description": "[Public Preview] Immutable. If set to true, the pipeline will ingest tables from the\nUC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.\nThe `source_catalog` fields in objects of IngestionConfig are interpreted as\nthe UC foreign catalogs to ingest from.", "$ref": "#/$defs/bool" }, "ingestion_gateway_id": { - "description": "Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database.\nThis is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC).\nUnder certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc\nManaged Ingestion Pipeline.", + "description": "[Public Preview] Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database.\nThis is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC).\nUnder certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc\nManaged Ingestion Pipeline.", "$ref": "#/$defs/string" }, "netsuite_jar_path": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "objects": { - "description": "Required. Settings specifying tables to replicate and the destination for the replicated tables.", + "description": "[Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig" }, "source_configurations": { - "description": "Top-level source configurations", + "description": "[Public Preview] Top-level source configurations", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.", + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig" } }, @@ -8936,15 +9143,15 @@ "description": "Configurations that are only applicable for query-based ingestion connectors.", "properties": { "cursor_columns": { - "description": "The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", + "description": "[Public Preview] The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", "$ref": "#/$defs/slice/string" }, "deletion_condition": { - "description": "Specifies a SQL WHERE condition that specifies that the source row has been deleted.\nThis is sometimes referred to as \"soft-deletes\".\nFor example: \"Operation = 'DELETE'\" or \"is_deleted = true\".\nThis field is orthogonal to `hard_deletion_sync_interval_in_seconds`,\none for soft-deletes and the other for hard-deletes.\nSee also the hard_deletion_sync_min_interval_in_seconds field for\nhandling of \"hard deletes\" where the source rows are physically removed from the table.", + "description": "[Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted.\nThis is sometimes referred to as \"soft-deletes\".\nFor example: \"Operation = 'DELETE'\" or \"is_deleted = true\".\nThis field is orthogonal to `hard_deletion_sync_interval_in_seconds`,\none for soft-deletes and the other for hard-deletes.\nSee also the hard_deletion_sync_min_interval_in_seconds field for\nhandling of \"hard deletes\" where the source rows are physically removed from the table.", "$ref": "#/$defs/string" }, "hard_deletion_sync_min_interval_in_seconds": { - "description": "Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", + "description": "[Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", "$ref": "#/$defs/int64" } }, @@ -8962,7 +9169,7 @@ "type": "object", "properties": { "incremental": { - "description": "(Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", + "description": "[Private Preview] (Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -8970,13 +9177,13 @@ "deprecated": true }, "parameters": { - "description": "Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", + "description": "[Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "report_parameters": { - "description": "(Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", + "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -8998,13 +9205,13 @@ "type": "object", "properties": { "key": { - "description": "Key for the report parameter, can be a column name or other metadata", + "description": "[Private Preview] Key for the report parameter, can be a column name or other metadata", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "value": { - "description": "Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", + "description": "[Private Preview] Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9043,6 +9250,28 @@ "META_MARKETING", "ZENDESK", "FOREIGN_CATALOG" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Private Preview]", + "[Beta]", + "[Public Preview]", + "[Beta]", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -9058,7 +9287,7 @@ "description": "Jira specific options for ingestion", "properties": { "include_jira_spaces": { - "description": "(Optional) Projects to filter Jira data on", + "description": "[Beta] (Optional) Projects to filter Jira data on", "$ref": "#/$defs/slice/string" } }, @@ -9076,31 +9305,31 @@ "type": "object", "properties": { "as_variant": { - "description": "Parse the entire value as a single Variant column.", + "description": "[Private Preview] Parse the entire value as a single Variant column.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "schema": { - "description": "Inline schema string for JSON parsing (Spark DDL format).", + "description": "[Private Preview] Inline schema string for JSON parsing (Spark DDL format).", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "schema_evolution_mode": { - "description": "(Optional) Schema evolution mode for schema inference.", + "description": "[Private Preview] (Optional) Schema evolution mode for schema inference.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "schema_file_path": { - "description": "Path to a schema file (.ddl).", + "description": "[Private Preview] Path to a schema file (.ddl).", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "schema_hints": { - "description": "(Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", + "description": "[Private Preview] (Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9120,43 +9349,43 @@ "type": "object", "properties": { "client_config": { - "description": "Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", + "description": "[Private Preview] Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "key_transformer": { - "description": "(Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", + "description": "[Private Preview] (Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "max_offsets_per_trigger": { - "description": "Internal option to control the maximum number of offsets to process per trigger.", + "description": "[Private Preview] Internal option to control the maximum number of offsets to process per trigger.", "$ref": "#/$defs/int64", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "starting_offset": { - "description": "(Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", + "description": "[Private Preview] (Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "topic_pattern": { - "description": "Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", + "description": "[Private Preview] Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "topics": { - "description": "Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", + "description": "[Private Preview] Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "value_transformer": { - "description": "(Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", + "description": "[Private Preview] (Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9189,35 +9418,35 @@ "description": "Meta Marketing (Meta Ads) specific options for ingestion", "properties": { "action_attribution_windows": { - "description": "(Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", + "description": "[Beta] (Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", "$ref": "#/$defs/slice/string" }, "action_breakdowns": { - "description": "(Optional) Action breakdowns to configure for data aggregation", + "description": "[Beta] (Optional) Action breakdowns to configure for data aggregation", "$ref": "#/$defs/slice/string" }, "action_report_time": { - "description": "(Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", + "description": "[Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", "$ref": "#/$defs/string" }, "breakdowns": { - "description": "(Optional) Breakdowns to configure for data aggregation", + "description": "[Beta] (Optional) Breakdowns to configure for data aggregation", "$ref": "#/$defs/slice/string" }, "custom_insights_lookback_window": { - "description": "(Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", + "description": "[Beta] (Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", "$ref": "#/$defs/int" }, "level": { - "description": "(Optional) Granularity of data to pull (account, ad, adset, campaign)", + "description": "[Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign)", "$ref": "#/$defs/string" }, "start_date": { - "description": "(Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested", + "description": "[Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested", "$ref": "#/$defs/string" }, "time_increment": { - "description": "(Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", + "description": "[Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", "$ref": "#/$defs/string" } }, @@ -9276,15 +9505,15 @@ "description": "Proto representing a window", "properties": { "days_of_week": { - "description": "Days of week in which the window is allowed to happen\nIf not specified all days of the week will be used.", + "description": "[Public Preview] Days of week in which the window is allowed to happen\nIf not specified all days of the week will be used.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek" }, "start_hour": { - "description": "An integer between 0 and 23 denoting the start hour for the window in the 24-hour day.", + "description": "[Public Preview] An integer between 0 and 23 denoting the start hour for the window in the 24-hour day.", "$ref": "#/$defs/int" }, "time_zone_id": { - "description": "Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", + "description": "[Public Preview] Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", "$ref": "#/$defs/string" } }, @@ -9309,6 +9538,12 @@ "NON_INLINE_ONLY", "INLINE_ONLY", "NONE" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -9325,6 +9560,10 @@ "enum": [ "TEXT_HTML", "TEXT_PLAIN" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, { @@ -9340,19 +9579,19 @@ "description": "Outlook specific options for ingestion", "properties": { "attachment_mode": { - "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", + "description": "[Private Preview] (Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "body_format": { - "description": "(Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", + "description": "[Private Preview] (Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "folder_filter": { - "description": "Deprecated. Use include_folders instead.", + "description": "[Private Preview] Deprecated. Use include_folders instead.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -9360,31 +9599,31 @@ "deprecated": true }, "include_folders": { - "description": "(Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", + "description": "[Private Preview] (Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "include_mailboxes": { - "description": "(Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", + "description": "[Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "include_senders": { - "description": "(Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", + "description": "[Private Preview] (Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "include_subjects": { - "description": "(Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", + "description": "[Private Preview] (Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "sender_filter": { - "description": "Deprecated. Use include_senders instead.", + "description": "[Private Preview] Deprecated. Use include_senders instead.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -9392,13 +9631,13 @@ "deprecated": true }, "start_date": { - "description": "(Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", + "description": "[Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "subject_filter": { - "description": "Deprecated. Use include_subjects instead.", + "description": "[Private Preview] Deprecated. Use include_subjects instead.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -9420,7 +9659,7 @@ "type": "object", "properties": { "include": { - "description": "The source code to include for pipelines", + "description": "[Public Preview] The source code to include for pipelines", "$ref": "#/$defs/string" } }, @@ -9574,7 +9813,7 @@ "type": "object", "properties": { "deployment_id": { - "description": "ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "description": "[Private Preview] ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9588,7 +9827,7 @@ "$ref": "#/$defs/string" }, "version_id": { - "description": "ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", + "description": "[Private Preview] ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9615,17 +9854,17 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileLibrary" }, "glob": { - "description": "The unified field to include source codes.\nEach entry can be a notebook path, a file path, or a folder path that ends `/**`.\nThis field cannot be used together with `notebook` or `file`.", + "description": "[Public Preview] The unified field to include source codes.\nEach entry can be a notebook path, a file path, or a folder path that ends `/**`.\nThis field cannot be used together with `notebook` or `file`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern" }, "jar": { - "description": "URI of the jar to be installed. Currently only DBFS is supported.", + "description": "[Private Preview] URI of the jar to be installed. Currently only DBFS is supported.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "maven": { - "description": "Specification of a maven library to be installed.", + "description": "[Private Preview] Specification of a maven library to be installed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9694,11 +9933,11 @@ "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip dependencies are supported.", "properties": { "dependencies": { - "description": "List of pip dependencies, as supported by the version of pip in this environment.\nEach dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/\nAllowed dependency could be \u003crequirement specifier\u003e, \u003carchive url/path\u003e, \u003clocal project path\u003e(WSFS or Volumes in Databricks), \u003cvcs project url\u003e", + "description": "[Public Preview] List of pip dependencies, as supported by the version of pip in this environment.\nEach dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/\nAllowed dependency could be \u003crequirement specifier\u003e, \u003carchive url/path\u003e, \u003clocal project path\u003e(WSFS or Volumes in Databricks), \u003cvcs project url\u003e", "$ref": "#/$defs/slice/string" }, "environment_version": { - "description": "The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", + "description": "[Private Preview] The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9719,7 +9958,7 @@ "description": "PG-specific catalog-level configuration parameters", "properties": { "slot_config": { - "description": "Optional. The Postgres slot configuration to use for logical replication", + "description": "[Public Preview] Optional. The Postgres slot configuration to use for logical replication", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig" } }, @@ -9738,11 +9977,11 @@ "description": "PostgresSlotConfig contains the configuration for a Postgres logical replication slot", "properties": { "publication_name": { - "description": "The name of the publication to use for the Postgres source", + "description": "[Public Preview] The name of the publication to use for the Postgres source", "$ref": "#/$defs/string" }, "slot_name": { - "description": "The name of the logical replication slot to use for the Postgres source", + "description": "[Public Preview] The name of the logical replication slot to use for the Postgres source", "$ref": "#/$defs/string" } }, @@ -9760,23 +9999,23 @@ "type": "object", "properties": { "destination_catalog": { - "description": "Required. Destination catalog to store table.", + "description": "[Public Preview] Required. Destination catalog to store table.", "$ref": "#/$defs/string" }, "destination_schema": { - "description": "Required. Destination schema to store table.", + "description": "[Public Preview] Required. Destination schema to store table.", "$ref": "#/$defs/string" }, "destination_table": { - "description": "Required. Destination table name. The pipeline fails if a table with that name already exists.", + "description": "[Public Preview] Required. Destination table name. The pipeline fails if a table with that name already exists.", "$ref": "#/$defs/string" }, "source_url": { - "description": "Required. Report URL in the source system.", + "description": "[Public Preview] Required. Report URL in the source system.", "$ref": "#/$defs/string" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object.", + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig" } }, @@ -9799,19 +10038,19 @@ "type": "object", "properties": { "days_of_week": { - "description": "Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", + "description": "[Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "start_hour": { - "description": "An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", + "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "time_zone_id": { - "description": "Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", + "description": "[Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9857,27 +10096,27 @@ "type": "object", "properties": { "connector_options": { - "description": "(Optional) Source Specific Connector Options", + "description": "[Public Preview] (Optional) Source Specific Connector Options", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions" }, "destination_catalog": { - "description": "Required. Destination catalog to store tables.", + "description": "[Public Preview] Required. Destination catalog to store tables.", "$ref": "#/$defs/string" }, "destination_schema": { - "description": "Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists.", + "description": "[Public Preview] Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists.", "$ref": "#/$defs/string" }, "source_catalog": { - "description": "The source catalog name. Might be optional depending on the type of source.", + "description": "[Public Preview] The source catalog name. Might be optional depending on the type of source.", "$ref": "#/$defs/string" }, "source_schema": { - "description": "Required. Schema name in the source database.", + "description": "[Public Preview] Required. Schema name in the source database.", "$ref": "#/$defs/string" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object.", + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig" } }, @@ -9900,19 +10139,19 @@ "type": "object", "properties": { "entity_type": { - "description": "(Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", + "description": "[Private Preview] (Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "file_ingestion_options": { - "description": "(Optional) File ingestion options for processing files.", + "description": "[Private Preview] (Optional) File ingestion options for processing files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "url": { - "description": "Required. The SharePoint URL.", + "description": "[Private Preview] Required. The SharePoint URL.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9935,6 +10174,12 @@ "FILE_METADATA", "PERMISSION", "LIST" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -9950,7 +10195,7 @@ "description": "Smartsheet specific options for ingestion", "properties": { "enforce_schema": { - "description": "(Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", + "description": "[Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -9971,11 +10216,11 @@ "description": "SourceCatalogConfig contains catalog-level custom configuration parameters for each source", "properties": { "postgres": { - "description": "Postgres-specific catalog-level configuration parameters", + "description": "[Public Preview] Postgres-specific catalog-level configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig" }, "source_catalog": { - "description": "Source catalog name", + "description": "[Public Preview] Source catalog name", "$ref": "#/$defs/string" } }, @@ -9993,10 +10238,11 @@ "type": "object", "properties": { "catalog": { - "description": "Catalog-level source configuration parameters", + "description": "[Public Preview] Catalog-level source configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig" }, "google_ads_config": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -10016,35 +10262,35 @@ "type": "object", "properties": { "connector_options": { - "description": "(Optional) Source Specific Connector Options", + "description": "[Public Preview] (Optional) Source Specific Connector Options", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions" }, "destination_catalog": { - "description": "Required. Destination catalog to store table.", + "description": "[Public Preview] Required. Destination catalog to store table.", "$ref": "#/$defs/string" }, "destination_schema": { - "description": "Required. Destination schema to store table.", + "description": "[Public Preview] Required. Destination schema to store table.", "$ref": "#/$defs/string" }, "destination_table": { - "description": "Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used.", + "description": "[Public Preview] Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used.", "$ref": "#/$defs/string" }, "source_catalog": { - "description": "Source catalog name. Might be optional depending on the type of source.", + "description": "[Public Preview] Source catalog name. Might be optional depending on the type of source.", "$ref": "#/$defs/string" }, "source_schema": { - "description": "Schema name in the source database. Might be optional depending on the type of source.", + "description": "[Public Preview] Schema name in the source database. Might be optional depending on the type of source.", "$ref": "#/$defs/string" }, "source_table": { - "description": "Required. Table name in the source database.", + "description": "[Public Preview] Required. Table name in the source database.", "$ref": "#/$defs/string" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec.", + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig" } }, @@ -10067,44 +10313,45 @@ "type": "object", "properties": { "auto_full_refresh_policy": { - "description": "(Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", + "description": "[Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy" }, "exclude_columns": { - "description": "A list of column names to be excluded for the ingestion.\nWhen not specified, include_columns fully controls what columns to be ingested.\nWhen specified, all other columns including future ones will be automatically included for ingestion.\nThis field in mutually exclusive with `include_columns`.", + "description": "[Public Preview] A list of column names to be excluded for the ingestion.\nWhen not specified, include_columns fully controls what columns to be ingested.\nWhen specified, all other columns including future ones will be automatically included for ingestion.\nThis field in mutually exclusive with `include_columns`.", "$ref": "#/$defs/slice/string" }, "include_columns": { - "description": "A list of column names to be included for the ingestion.\nWhen not specified, all columns except ones in exclude_columns will be included. Future\ncolumns will be automatically included.\nWhen specified, all other future columns will be automatically excluded from ingestion.\nThis field in mutually exclusive with `exclude_columns`.", + "description": "[Public Preview] A list of column names to be included for the ingestion.\nWhen not specified, all columns except ones in exclude_columns will be included. Future\ncolumns will be automatically included.\nWhen specified, all other future columns will be automatically excluded from ingestion.\nThis field in mutually exclusive with `exclude_columns`.", "$ref": "#/$defs/slice/string" }, "primary_keys": { - "description": "The primary key of the table used to apply changes.", + "description": "[Public Preview] The primary key of the table used to apply changes.", "$ref": "#/$defs/slice/string" }, "query_based_connector_config": { - "description": "Configurations that are only applicable for query-based ingestion connectors.", + "description": "[Public Preview] Configurations that are only applicable for query-based ingestion connectors.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig" }, "row_filter": { - "description": "(Optional, Immutable) The row filter condition to be applied to the table.\nIt must not contain the WHERE keyword, only the actual filter condition.\nIt must be in DBSQL format.", + "description": "[Public Preview] (Optional, Immutable) The row filter condition to be applied to the table.\nIt must not contain the WHERE keyword, only the actual filter condition.\nIt must be in DBSQL format.", "$ref": "#/$defs/string" }, "salesforce_include_formula_fields": { - "description": "If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", + "description": "[Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "scd_type": { - "description": "The SCD type to use to ingest the table.", + "description": "[Public Preview] The SCD type to use to ingest the table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType" }, "sequence_by": { - "description": "The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order.", + "description": "[Public Preview] The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order.", "$ref": "#/$defs/slice/string" }, "workday_report_parameters": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -10127,6 +10374,11 @@ "SCD_TYPE_1", "SCD_TYPE_2", "APPEND_ONLY" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -10142,43 +10394,43 @@ "description": "TikTok Ads specific options for ingestion", "properties": { "data_level": { - "description": "(Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "dimensions": { - "description": "(Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", + "description": "[Private Preview] (Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", + "description": "[Private Preview] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "metrics": { - "description": "(Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", + "description": "[Private Preview] (Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "query_lifetime": { - "description": "(Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", + "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "report_type": { - "description": "(Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", + "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -10202,6 +10454,12 @@ "AUCTION_CAMPAIGN", "AUCTION_ADGROUP", "AUCTION_AD" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -10222,6 +10480,14 @@ "DSA", "BUSINESS_CENTER", "GMV_MAX" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, { @@ -10237,12 +10503,13 @@ "description": "Specifies how to transform binary data into structured data.", "properties": { "format": { - "description": "Required: the wire format of the data.", + "description": "[Private Preview] Required: the wire format of the data.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", "x-databricks-preview": "PRIVATE", "doNotSuggest": true }, "json_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JsonTransformerOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -10263,6 +10530,10 @@ "enum": [ "STRING", "JSON" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, { @@ -10278,7 +10549,7 @@ "description": "Zendesk Support specific options for ingestion", "properties": { "start_date": { - "description": "(Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", + "description": "[Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true @@ -10298,15 +10569,15 @@ "type": "object", "properties": { "enable_readable_secondaries": { - "description": "Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1.", + "description": "[Beta] Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1.", "$ref": "#/$defs/bool" }, "max": { - "description": "The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec.", + "description": "[Beta] The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec.", "$ref": "#/$defs/int" }, "min": { - "description": "The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1.", + "description": "[Beta] The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1.", "$ref": "#/$defs/int" } }, @@ -10329,7 +10600,7 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "pg_settings": { - "description": "A raw representation of Postgres settings.", + "description": "[Beta] A raw representation of Postgres settings.", "$ref": "#/$defs/map/string" } }, @@ -10349,6 +10620,10 @@ "enum": [ "ENDPOINT_TYPE_READ_WRITE", "ENDPOINT_TYPE_READ_ONLY" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, { @@ -10363,15 +10638,15 @@ "type": "object", "properties": { "budget_policy_id": { - "description": "Budget policy to set on the newly created pipeline.", + "description": "[Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string" }, "storage_catalog": { - "description": "UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", + "description": "[Beta] UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string" }, "storage_schema": { - "description": "UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", + "description": "[Beta] UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string" } }, @@ -10389,11 +10664,11 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", + "description": "[Beta] The key of the custom tag.", "$ref": "#/$defs/string" }, "value": { - "description": "The value of the custom tag.", + "description": "[Beta] The value of the custom tag.", "$ref": "#/$defs/string" } }, @@ -10412,23 +10687,23 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "autoscaling_limit_max_cu": { - "description": "The maximum number of Compute Units. Minimum value is 0.5.", + "description": "[Beta] The maximum number of Compute Units. Minimum value is 0.5.", "$ref": "#/$defs/float64" }, "autoscaling_limit_min_cu": { - "description": "The minimum number of Compute Units. Minimum value is 0.5.", + "description": "[Beta] The minimum number of Compute Units. Minimum value is 0.5.", "$ref": "#/$defs/float64" }, "no_suspension": { - "description": "When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", + "description": "[Beta] When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", "$ref": "#/$defs/bool" }, "pg_settings": { - "description": "A raw representation of Postgres settings.", + "description": "[Beta] A raw representation of Postgres settings.", "$ref": "#/$defs/map/string" }, "suspend_timeout_duration": { - "description": "Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", + "description": "[Beta] Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration" } }, @@ -10449,6 +10724,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]", + "[Beta]" ] }, { @@ -10489,7 +10769,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.FallbackConfig" }, "guardrails": { - "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", + "description": "[Public Preview] Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails" }, "inference_table_config": { @@ -10519,21 +10799,21 @@ "type": "object", "properties": { "invalid_keywords": { - "description": "List of invalid keywords.\nAI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.", + "description": "[Public Preview] List of invalid keywords.\nAI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.", "$ref": "#/$defs/slice/string", "deprecationMessage": "This field is deprecated", "deprecated": true }, "pii": { - "description": "Configuration for guardrail PII filter.", + "description": "[Public Preview] Configuration for guardrail PII filter.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior" }, "safety": { - "description": "Indicates whether the safety filter is enabled.", + "description": "[Public Preview] Indicates whether the safety filter is enabled.", "$ref": "#/$defs/bool" }, "valid_topics": { - "description": "The list of allowed topics.\nGiven a chat request, this guardrail flags the request if its topic is not in the allowed topics.", + "description": "[Public Preview] The list of allowed topics.\nGiven a chat request, this guardrail flags the request if its topic is not in the allowed topics.", "$ref": "#/$defs/slice/string", "deprecationMessage": "This field is deprecated", "deprecated": true @@ -10553,7 +10833,7 @@ "type": "object", "properties": { "behavior": { - "description": "Configuration for input guardrail filters.", + "description": "[Public Preview] Configuration for input guardrail filters.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior" } }, @@ -10573,6 +10853,11 @@ "NONE", "BLOCK", "MASK" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -10587,11 +10872,11 @@ "type": "object", "properties": { "input": { - "description": "Configuration for input guardrail filters.", + "description": "[Public Preview] Configuration for input guardrail filters.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters" }, "output": { - "description": "Configuration for output guardrail filters.", + "description": "[Public Preview] Configuration for output guardrail filters.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters" } }, @@ -10679,6 +10964,12 @@ "endpoint", "user_group", "service_principal" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -10693,6 +10984,9 @@ "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[Public Preview]" ] }, { @@ -10774,6 +11068,12 @@ "cohere", "ai21labs", "amazon" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -11131,6 +11431,17 @@ "openai", "palm", "custom" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -11312,6 +11623,10 @@ "enum": [ "user", "endpoint" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, { @@ -11326,6 +11641,9 @@ "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[Public Preview]" ] }, { @@ -11368,7 +11686,7 @@ "type": "object", "properties": { "burst_scaling_enabled": { - "description": "Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", + "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", "$ref": "#/$defs/bool" }, "entity_name": { @@ -11387,7 +11705,7 @@ "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.ExternalModel" }, "instance_profile_arn": { - "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", "$ref": "#/$defs/string" }, "max_provisioned_concurrency": { @@ -11411,7 +11729,7 @@ "$ref": "#/$defs/string" }, "provisioned_model_units": { - "description": "The number of model units provisioned.", + "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64" }, "scale_to_zero_enabled": { @@ -11441,7 +11759,7 @@ "type": "object", "properties": { "burst_scaling_enabled": { - "description": "Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", + "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", "$ref": "#/$defs/bool" }, "environment_vars": { @@ -11449,7 +11767,7 @@ "$ref": "#/$defs/map/string" }, "instance_profile_arn": { - "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", "$ref": "#/$defs/string" }, "max_provisioned_concurrency": { @@ -11479,7 +11797,7 @@ "$ref": "#/$defs/string" }, "provisioned_model_units": { - "description": "The number of model units provisioned.", + "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64" }, "scale_to_zero_enabled": { @@ -11520,6 +11838,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, { @@ -11557,6 +11883,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, { @@ -11596,6 +11930,16 @@ "MIN", "MAX", "STDDEV" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -11614,6 +11958,12 @@ "TRIGGERED", "OK", "ERROR" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -11629,6 +11979,10 @@ "enum": [ "ACTIVE", "DELETED" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, { @@ -11643,23 +11997,23 @@ "type": "object", "properties": { "comparison_operator": { - "description": "Operator used for comparison in alert evaluation.", + "description": "[Public Preview] Operator used for comparison in alert evaluation.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator" }, "empty_result_state": { - "description": "Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", + "description": "[Public Preview] Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState" }, "notification": { - "description": "User or Notification Destination to notify when alert is triggered.", + "description": "[Public Preview] User or Notification Destination to notify when alert is triggered.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Notification" }, "source": { - "description": "Source column from result to use to evaluate alert", + "description": "[Public Preview] Source column from result to use to evaluate alert", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn" }, "threshold": { - "description": "Threshold to user for alert evaluation, can be a column or a value.", + "description": "[Public Preview] Threshold to user for alert evaluation, can be a column or a value.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Operand" } }, @@ -11681,14 +12035,15 @@ "type": "object", "properties": { "notify_on_ok": { - "description": "Whether to notify alert subscribers when alert returns back to normal.", + "description": "[Public Preview] Whether to notify alert subscribers when alert returns back to normal.", "$ref": "#/$defs/bool" }, "retrigger_seconds": { - "description": "Number of seconds an alert waits after being triggered before it is allowed to send another notification.\nIf set to 0 or omitted, the alert will not send any further notifications after the first trigger\nSetting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes.", + "description": "[Public Preview] Number of seconds an alert waits after being triggered before it is allowed to send another notification.\nIf set to 0 or omitted, the alert will not send any further notifications after the first trigger\nSetting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes.", "$ref": "#/$defs/int" }, "subscriptions": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription" } }, @@ -11706,9 +12061,11 @@ "type": "object", "properties": { "column": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn" }, "value": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue" } }, @@ -11726,12 +12083,15 @@ "type": "object", "properties": { "aggregation": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation" }, "display": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "name": { + "description": "[Public Preview]", "$ref": "#/$defs/string" } }, @@ -11752,12 +12112,15 @@ "type": "object", "properties": { "bool_value": { + "description": "[Public Preview]", "$ref": "#/$defs/bool" }, "double_value": { + "description": "[Public Preview]", "$ref": "#/$defs/float64" }, "string_value": { + "description": "[Public Preview]", "$ref": "#/$defs/string" } }, @@ -11775,11 +12138,11 @@ "type": "object", "properties": { "service_principal_name": { - "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", + "description": "[Public Preview] Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", "$ref": "#/$defs/string" }, "user_name": { - "description": "The email of an active workspace user. Can only set this field to their own email.", + "description": "[Public Preview] The email of an active workspace user. Can only set this field to their own email.", "$ref": "#/$defs/string" } }, @@ -11797,9 +12160,11 @@ "type": "object", "properties": { "destination_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string" }, "user_email": { + "description": "[Public Preview]", "$ref": "#/$defs/string" } }, @@ -11862,6 +12227,16 @@ "LESS_THAN_OR_EQUAL", "IS_NULL", "IS_NOT_NULL" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, { @@ -11892,15 +12267,15 @@ "type": "object", "properties": { "pause_status": { - "description": "Indicate whether this schedule is paused or not.", + "description": "[Public Preview] Indicate whether this schedule is paused or not.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus" }, "quartz_cron_schedule": { - "description": "A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", + "description": "[Public Preview] A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", "$ref": "#/$defs/string" }, "timezone_id": { - "description": "A Java timezone id. The schedule will be resolved using this timezone.\nThis will be combined with the quartz_cron_schedule to determine the schedule.\nSee https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.", + "description": "[Public Preview] A Java timezone id. The schedule will be resolved using this timezone.\nThis will be combined with the quartz_cron_schedule to determine the schedule.\nSee https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.", "$ref": "#/$defs/string" } }, @@ -11960,6 +12335,10 @@ "enum": [ "UNPAUSED", "PAUSED" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, { @@ -12114,6 +12493,10 @@ "enum": [ "STORAGE_OPTIMIZED", "STANDARD" + ], + "enumDescriptions": [ + "[Public Preview]", + "" ] }, { @@ -12131,6 +12514,11 @@ "VECTOR", "FULL_TEXT", "HYBRID" + ], + "enumDescriptions": [ + "[Beta] Not supported. Use `HYBRID` instead.", + "[Beta] An index that uses full-text search without vector embeddings.", + "[Beta] An index that uses vector embeddings for similarity search and hybrid search." ] }, { @@ -12147,6 +12535,10 @@ "enum": [ "TRIGGERED", "CONTINUOUS" + ], + "enumDescriptions": [ + "If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.", + "If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh." ] }, { @@ -12163,6 +12555,10 @@ "enum": [ "DELTA_SYNC", "DIRECT_ACCESS" + ], + "enumDescriptions": [ + "An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.", + "An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates." ] }, { diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index 522f8e38acf..7efe3ffebda 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -22,18 +22,22 @@ "type": "object", "properties": { "custom_description": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "custom_summary": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "display_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "evaluation": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation", "x-since-version": "v0.279.0" }, @@ -46,6 +50,7 @@ "x-since-version": "v0.279.0" }, "parent_path": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, @@ -54,24 +59,29 @@ "x-since-version": "v0.279.0" }, "query_text": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "run_as": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs", "x-since-version": "v0.279.0" }, "run_as_user_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.279.0", "deprecated": true }, "schedule": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule", "x-since-version": "v0.279.0" }, "warehouse_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -89,16 +99,19 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.243.0" }, "compute_max_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.2.0" }, "compute_min_instances": { + "description": "[Private Preview]", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -151,21 +164,24 @@ "x-since-version": "v0.239.0" }, "space": { - "description": "Name of the space this app belongs to.", + "description": "[Private Preview] Name of the space this app belongs to.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.290.0" }, "telemetry_export_destinations": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination", "x-since-version": "v0.294.0" }, "usage_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.283.0" }, "user_api_scopes": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/string", "x-since-version": "v0.246.0" } @@ -584,16 +600,17 @@ "type": "object", "properties": { "create_database_if_not_exists": { + "description": "[Public Preview]", "$ref": "#/$defs/bool", "x-since-version": "v0.265.0" }, "database_instance_name": { - "description": "The name of the DatabaseInstance housing the database.", + "description": "[Public Preview] The name of the DatabaseInstance housing the database.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" }, "database_name": { - "description": "The name of the database (in a instance) associated with the catalog.", + "description": "[Public Preview] The name of the database (in a instance) associated with the catalog.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" }, @@ -603,7 +620,7 @@ "x-since-version": "v0.268.0" }, "name": { - "description": "The name of the catalog in UC.", + "description": "[Public Preview] The name of the catalog in UC.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" } @@ -620,22 +637,22 @@ "description": "A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.", "properties": { "capacity": { - "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "description": "[Public Preview] The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" }, "custom_tags": { - "description": "Custom tags associated with the instance. This field is only included on create and update responses.", + "description": "[Beta] Custom tags associated with the instance. This field is only included on create and update responses.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.CustomTag", "x-since-version": "v0.273.0" }, "enable_pg_native_login": { - "description": "Whether to enable PG native password login on the instance. Defaults to false.", + "description": "[Public Preview] Whether to enable PG native password login on the instance. Defaults to false.", "$ref": "#/$defs/bool", "x-since-version": "v0.267.0" }, "enable_readable_secondaries": { - "description": "Whether to enable secondaries to serve read-only traffic. Defaults to false.", + "description": "[Public Preview] Whether to enable secondaries to serve read-only traffic. Defaults to false.", "$ref": "#/$defs/bool", "x-since-version": "v0.265.0" }, @@ -645,17 +662,17 @@ "x-since-version": "v0.268.0" }, "name": { - "description": "The name of the instance. This is the unique identifier for the instance.", + "description": "[Public Preview] The name of the instance. This is the unique identifier for the instance.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" }, "node_count": { - "description": "The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see effective_node_count for the output.", + "description": "[Public Preview] The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see effective_node_count for the output.", "$ref": "#/$defs/int", "x-since-version": "v0.265.0" }, "parent_instance_ref": { - "description": "The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", + "description": "[Public Preview] The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef", "x-since-version": "v0.265.0" }, @@ -664,17 +681,17 @@ "x-since-version": "v0.265.0" }, "retention_window_in_days": { - "description": "The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days.", + "description": "[Public Preview] The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days.", "$ref": "#/$defs/int", "x-since-version": "v0.265.0" }, "stopped": { - "description": "Whether to stop the instance. An input only param, see effective_stopped for the output.", + "description": "[Public Preview] Whether to stop the instance. An input only param, see effective_stopped for the output.", "$ref": "#/$defs/bool", "x-since-version": "v0.265.0" }, "usage_policy_id": { - "description": "The desired usage policy to associate with the instance.", + "description": "[Beta] The desired usage policy to associate with the instance.", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" } @@ -795,7 +812,7 @@ "type": "object", "properties": { "budget_policy_id": { - "description": "The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", + "description": "[Public Preview] The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", "$ref": "#/$defs/string", "x-since-version": "v0.231.0" }, @@ -902,7 +919,7 @@ "x-since-version": "v0.229.0" }, "usage_policy_id": { - "description": "The id of the user specified usage policy to use for this job.\nIf not specified, a default usage policy may be applied when creating or modifying the job.\nSee `effective_usage_policy_id` for the usage policy used by this workload.", + "description": "[Private Preview] The id of the user specified usage policy to use for this job.\nIf not specified, a default usage policy may be applied when creating or modifying the job.\nSee `effective_usage_policy_id` for the usage policy used by this workload.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -1215,7 +1232,7 @@ "x-since-version": "v0.261.0" }, "budget_policy_id": { - "description": "Budget policy of this pipeline.", + "description": "[Public Preview] Budget policy of this pipeline.", "$ref": "#/$defs/string", "x-since-version": "v0.230.0" }, @@ -1255,7 +1272,7 @@ "x-since-version": "v0.229.0" }, "environment": { - "description": "Environment specification for this pipeline used to install dependencies.", + "description": "[Public Preview] Environment specification for this pipeline used to install dependencies.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment", "x-since-version": "v0.257.0" }, @@ -1270,7 +1287,7 @@ "x-since-version": "v0.229.0" }, "gateway_definition": { - "description": "The definition of a gateway pipeline to support change data capture.", + "description": "[Private Preview] The definition of a gateway pipeline to support change data capture.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -1282,7 +1299,7 @@ "x-since-version": "v0.229.0" }, "ingestion_definition": { - "description": "The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "description": "[Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition", "x-since-version": "v0.229.0" }, @@ -1307,6 +1324,7 @@ "x-since-version": "v0.229.0" }, "parameters": { + "description": "[Beta]", "$ref": "#/$defs/map/string", "x-since-version": "v1.2.0" }, @@ -1320,14 +1338,14 @@ "x-since-version": "v0.229.0" }, "restart_window": { - "description": "Restart window of this pipeline.", + "description": "[Private Preview] Restart window of this pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.234.0" }, "root_path": { - "description": "Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", + "description": "[Public Preview] Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", "$ref": "#/$defs/string", "x-since-version": "v0.253.0" }, @@ -1370,7 +1388,7 @@ "deprecated": true }, "usage_policy_id": { - "description": "Usage policy of this pipeline.", + "description": "[Private Preview] Usage policy of this pipeline.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -1677,7 +1695,7 @@ "x-since-version": "v0.229.0" }, "data_classification_config": { - "description": "[Create:OPT Update:OPT] Data classification related config.", + "description": "[Private Preview] [Create:OPT Update:OPT] Data classification related config.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificationConfig", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -2052,6 +2070,7 @@ "type": "object", "properties": { "database_instance_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, @@ -2060,14 +2079,17 @@ "x-since-version": "v0.268.0" }, "logical_database_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "spec": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec", "x-since-version": "v0.266.0" } @@ -2081,6 +2103,7 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.298.0" }, @@ -2101,10 +2124,12 @@ "x-since-version": "v0.298.0" }, "target_qps": { + "description": "[Public Preview]", "$ref": "#/$defs/int64", "x-since-version": "v0.299.2" }, "usage_policy_id": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -2137,6 +2162,7 @@ "x-since-version": "v1.1.0" }, "index_subtype": { + "description": "[Beta]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.IndexSubtype", "x-since-version": "v1.1.0" }, @@ -3727,7 +3753,7 @@ "description": "Data classification related configuration.", "properties": { "enabled": { - "description": "Whether to enable data classification.", + "description": "[Private Preview] Whether to enable data classification.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -3859,7 +3885,7 @@ "x-since-version": "v0.229.0" }, "on_new_classification_tag_detected": { - "description": "Destinations to send notifications on new classification tag detected.", + "description": "[Private Preview] Destinations to send notifications on new classification tag detected.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -4384,6 +4410,10 @@ "enum": [ "CONFIDENTIAL_COMPUTE_TYPE_NONE", "SEV_SNP" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, "compute.DataSecurityMode": { @@ -4400,6 +4430,18 @@ "DATA_SECURITY_MODE_STANDARD", "DATA_SECURITY_MODE_DEDICATED", "DATA_SECURITY_MODE_AUTO" + ], + "enumDescriptions": [ + "", + "Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.", + "Legacy alias for `DATA_SECURITY_MODE_STANDARD`.", + "This mode is for users migrating from legacy Table ACL clusters.", + "This mode is for users migrating from legacy Passthrough on high concurrency clusters.", + "This mode is for users migrating from legacy Passthrough on standard clusters.", + "This mode provides a way that doesn’t have UC nor passthrough enabled.", + "A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.", + "A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.", + "\u003cDatabricks\u003e will choose the most appropriate access mode depending on your compute configuration." ] }, "compute.DbfsStorageInfo": { @@ -4483,6 +4525,7 @@ "x-since-version": "v0.252.0" }, "java_dependencies": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/string", "x-since-version": "v0.271.0" } @@ -4503,7 +4546,7 @@ "x-since-version": "v0.229.0" }, "confidential_compute_type": { - "description": "The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", + "description": "[Private Preview] The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ConfidentialComputeType", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -4569,6 +4612,10 @@ "enum": [ "GPU_1xA10", "GPU_8xH100" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "compute.InitScriptInfo": { @@ -4878,12 +4925,12 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", + "description": "[Public Preview] The key of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" }, "value": { - "description": "The value of the custom tag.", + "description": "[Public Preview] The value of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.273.0" } @@ -4895,17 +4942,17 @@ "description": "DatabaseInstanceRef is a reference to a database instance. It is used in the\nDatabaseInstance object to refer to the parent instance of an instance and\nto refer the child instances of an instance.\nTo specify as a parent instance during creation of an instance,\nthe lsn and branch_time fields are optional. If not specified, the child\ninstance will be created from the latest lsn of the parent.\nIf both lsn and branch_time are specified, the lsn will be used to create\nthe child instance.", "properties": { "branch_time": { - "description": "Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", + "description": "[Public Preview] Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" }, "lsn": { - "description": "User-specified WAL LSN of the ref database instance.\n\nInput: For specifying the WAL LSN to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", + "description": "[Public Preview] User-specified WAL LSN of the ref database instance.\n\nInput: For specifying the WAL LSN to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" }, "name": { - "description": "Name of the ref database instance.", + "description": "[Public Preview] Name of the ref database instance.", "$ref": "#/$defs/string", "x-since-version": "v0.265.0" } @@ -4921,6 +4968,14 @@ "STOPPED", "UPDATING", "FAILING_OVER" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "database.DeltaTableSyncInfo": { @@ -4932,17 +4987,17 @@ "description": "Custom fields that user can set for pipeline while creating SyncedDatabaseTable.\nNote that other fields of pipeline are still inferred by table def internally", "properties": { "budget_policy_id": { - "description": "Budget policy to set on the newly created pipeline.", + "description": "[Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "storage_catalog": { - "description": "This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", + "description": "[Public Preview] This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "storage_schema": { - "description": "This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", + "description": "[Public Preview] This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" } @@ -4958,6 +5013,14 @@ "DELETING", "UPDATING", "DEGRADED" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "database.ProvisioningPhase": { @@ -4966,6 +5029,11 @@ "PROVISIONING_PHASE_MAIN", "PROVISIONING_PHASE_INDEX_SCAN", "PROVISIONING_PHASE_INDEX_SORT" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "database.SyncedTableContinuousUpdateStatus": { @@ -4998,6 +5066,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "database.SyncedTableSpec": { @@ -5005,37 +5078,37 @@ "description": "Specification of a synced database table.", "properties": { "create_database_objects_if_missing": { - "description": "If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.", + "description": "[Public Preview] If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.", "$ref": "#/$defs/bool", "x-since-version": "v0.266.0" }, "existing_pipeline_id": { - "description": "At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline\nreferenced. This avoids creating a new pipeline and allows sharing existing compute.\nIn this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline.", + "description": "[Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline\nreferenced. This avoids creating a new pipeline and allows sharing existing compute.\nIn this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline.", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "new_pipeline_spec": { - "description": "At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used\nto store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta\ntables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table\nonly requires read permissions.", + "description": "[Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used\nto store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta\ntables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table\nonly requires read permissions.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec", "x-since-version": "v0.266.0" }, "primary_key_columns": { - "description": "Primary Key columns to be used for data insert/update in the destination.", + "description": "[Public Preview] Primary Key columns to be used for data insert/update in the destination.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.266.0" }, "scheduling_policy": { - "description": "Scheduling policy of the underlying pipeline.", + "description": "[Public Preview] Scheduling policy of the underlying pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPolicy", "x-since-version": "v0.266.0" }, "source_table_full_name": { - "description": "Three-part (catalog, schema, table) name of the source Delta table.", + "description": "[Public Preview] Three-part (catalog, schema, table) name of the source Delta table.", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" }, "timeseries_key": { - "description": "Time series key to deduplicate (tie-break) rows with the same primary key.", + "description": "[Public Preview] Time series key to deduplicate (tie-break) rows with the same primary key.", "$ref": "#/$defs/string", "x-since-version": "v0.266.0" } @@ -5057,6 +5130,19 @@ "SYNCED_TABLE_OFFLINE_FAILED", "SYNCED_TABLE_ONLINE_PIPELINE_FAILED", "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "database.SyncedTableStatus": { @@ -5064,22 +5150,22 @@ "description": "Status of a synced table.", "properties": { "continuous_update_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE\nor the SYNCED_UPDATING_PIPELINE_RESOURCES state.", + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE\nor the SYNCED_UPDATING_PIPELINE_RESOURCES state.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus", "x-since-version": "v0.266.0" }, "failed_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus", "x-since-version": "v0.266.0" }, "provisioning_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioningStatus", "x-since-version": "v0.266.0" }, "triggered_update_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE\nor the SYNCED_NO_PENDING_UPDATE state.", + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE\nor the SYNCED_NO_PENDING_UPDATE state.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpdateStatus", "x-since-version": "v0.266.0" } @@ -5115,28 +5201,50 @@ "CAN_CREATE", "CAN_MONITOR_ONLY", "CAN_CREATE_APP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "[Private Preview]", + "[Private Preview]" ] }, "jobs.AlertTask": { "type": "object", "properties": { "alert_id": { - "description": "The alert_id is the canonical identifier of the alert.", + "description": "[Public Preview] The alert_id is the canonical identifier of the alert.", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" }, "subscribers": { - "description": "The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", + "description": "[Public Preview] The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber", "x-since-version": "v0.296.0" }, "warehouse_id": { - "description": "The warehouse_id identifies the warehouse settings used by the alert task.", + "description": "[Public Preview] The warehouse_id identifies the warehouse settings used by the alert task.", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" }, "workspace_path": { - "description": "The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", + "description": "[Public Preview] The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" } @@ -5148,11 +5256,12 @@ "description": "Represents a subscriber that will receive alert notifications.\nA subscriber can be either a user (via email) or a notification destination (via destination_id).", "properties": { "destination_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" }, "user_name": { - "description": "A valid workspace email address.", + "description": "[Public Preview] A valid workspace email address.", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" } @@ -5164,6 +5273,10 @@ "enum": [ "OAUTH", "PAT" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, "jobs.CleanRoomsNotebookTask": { @@ -5201,7 +5314,7 @@ "type": "object", "properties": { "hardware_accelerator": { - "description": "Hardware accelerator configuration for Serverless GPU workloads.", + "description": "[Beta] Hardware accelerator configuration for Serverless GPU workloads.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType", "x-since-version": "v0.288.0" } @@ -5212,21 +5325,21 @@ "type": "object", "properties": { "gpu_node_pool_id": { - "description": "IDof the GPU pool to use.", + "description": "[Private Preview] IDof the GPU pool to use.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "gpu_type": { - "description": "GPU type.", + "description": "[Private Preview] GPU type.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "num_gpus": { - "description": "Number of GPUs.", + "description": "[Private Preview] Number of GPUs.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5333,7 +5446,7 @@ "x-since-version": "v0.248.0" }, "filters": { - "description": "Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key.\nThe parameter value format is dependent on the filter type:\n- For text and single-select filters, provide a single value (e.g. `\"value\"`)\n- For date and datetime filters, provide the value in ISO 8601 format (e.g. `\"2000-01-01T00:00:00\"`)\n- For multi-select filters, provide a JSON array of values (e.g. `\"[\\\"value1\\\",\\\"value2\\\"]\"`)\n- For range and date range filters, provide a JSON object with `start` and `end` (e.g. `\"{\\\"start\\\":\\\"1\\\",\\\"end\\\":\\\"10\\\"}\"`)", + "description": "[Private Preview] Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key.\nThe parameter value format is dependent on the filter type:\n- For text and single-select filters, provide a single value (e.g. `\"value\"`)\n- For date and datetime filters, provide the value in ISO 8601 format (e.g. `\"2000-01-01T00:00:00\"`)\n- For multi-select filters, provide a JSON array of values (e.g. `\"[\\\"value1\\\",\\\"value2\\\"]\"`)\n- For range and date range filters, provide a JSON object with `start` and `end` (e.g. `\"{\\\"start\\\":\\\"1\\\",\\\"end\\\":\\\"10\\\"}\"`)", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5356,14 +5469,14 @@ "description": "Deprecated in favor of DbtPlatformTask", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt Cloud for this task", + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt Cloud for this task", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.256.0" }, "dbt_cloud_job_id": { - "description": "Id of the dbt Cloud job to be triggered", + "description": "[Private Preview] Id of the dbt Cloud job to be triggered", "$ref": "#/$defs/int64", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5376,14 +5489,14 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt platform for this task", + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.257.0" }, "dbt_platform_job_id": { - "description": "Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", + "description": "[Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5496,55 +5609,56 @@ "type": "object", "properties": { "command": { - "description": "Command launcher to run the actual script, e.g. bash, python etc.", + "description": "[Private Preview] Command launcher to run the actual script, e.g. bash, python etc.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "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", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "dl_runtime_image": { - "description": "Runtime image", + "description": "[Private Preview] Runtime image", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "mlflow_experiment_name": { - "description": "Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", + "description": "[Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "source": { - "description": "Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", + "description": "[Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "training_script_path": { - "description": "The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", + "description": "[Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "yaml_parameters": { - "description": "Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", + "description": "[Private Preview] Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.243.0" }, "yaml_parameters_file_path": { - "description": "Optional path to a YAML file containing model parameters passed to the training script.", + "description": "[Private Preview] Optional path to a YAML file containing model parameters passed to the training script.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5645,7 +5759,7 @@ "type": "object", "properties": { "deployment_id": { - "description": "ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "description": "[Private Preview] ID of the deployment that manages this job. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5662,7 +5776,7 @@ "x-since-version": "v0.229.0" }, "version_id": { - "description": "ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", + "description": "[Private Preview] ID of the version of the deployment that produced this job. Only set\nwhen `kind` is `BUNDLE`. Identifies a specific snapshot of the deployment\nin the Deployment Metadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5680,6 +5794,10 @@ "enum": [ "BUNDLE", "SYSTEM_MANAGED" + ], + "enumDescriptions": [ + "The job is managed by Databricks Asset Bundle.", + "[Beta] The job is managed by \u003cDatabricks\u003e and is read-only." ] }, "jobs.JobEditMode": { @@ -5688,6 +5806,10 @@ "enum": [ "UI_LOCKED", "EDITABLE" + ], + "enumDescriptions": [ + "The job is in a locked UI state and cannot be modified.", + "The job is in an editable state and can be modified." ] }, "jobs.JobEmailNotifications": { @@ -5716,7 +5838,7 @@ "x-since-version": "v0.229.0" }, "on_streaming_backlog_exceeded": { - "description": "A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", + "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.229.0" }, @@ -5797,7 +5919,7 @@ "description": "Write-only setting. Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who created the job.\n\nEither `user_name` or `service_principal_name` should be specified. If not, an error is thrown.", "properties": { "group_name": { - "description": "Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", + "description": "[Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5821,21 +5943,21 @@ "description": "The source of the job specification in the remote repository when the job is source controlled.", "properties": { "dirty_state": { - "description": "Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", + "description": "[Private Preview] Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "import_from_git_branch": { - "description": "Name of the branch which the job is imported from.", + "description": "[Private Preview] Name of the branch which the job is imported from.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "job_config_path": { - "description": "Path of the job YAML file that contains the job specification.", + "description": "[Private Preview] Path of the job YAML file that contains the job specification.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5854,6 +5976,10 @@ "enum": [ "NOT_SYNCED", "DISCONNECTED" + ], + "enumDescriptions": [ + "[Private Preview] The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.", + "[Private Preview] The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced." ] }, "jobs.JobsHealthMetric": { @@ -5865,6 +5991,13 @@ "STREAMING_BACKLOG_RECORDS", "STREAMING_BACKLOG_SECONDS", "STREAMING_BACKLOG_FILES" + ], + "enumDescriptions": [ + "Expected total time for a run in seconds.", + "An estimate of the maximum bytes of data waiting to be consumed across all streams. This metric is in Public Preview.", + "An estimate of the maximum offset lag across all streams. This metric is in Public Preview.", + "An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.", + "An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview." ] }, "jobs.JobsHealthOperator": { @@ -5913,35 +6046,35 @@ "type": "object", "properties": { "aliases": { - "description": "Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", + "description": "[Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "condition": { - "description": "The condition based on which to trigger a job run.", + "description": "[Private Preview] The condition based on which to trigger a job run.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "min_time_between_triggers_seconds": { - "description": "If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", + "description": "[Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "securable_name": { - "description": "Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", + "description": "[Private Preview] Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "wait_after_last_change_seconds": { - "description": "If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", + "description": "[Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -5959,6 +6092,11 @@ "MODEL_CREATED", "MODEL_VERSION_READY", "MODEL_ALIAS_SET" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "jobs.NotebookTask": { @@ -6042,22 +6180,22 @@ "x-since-version": "v0.229.0" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", + "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "refresh_flow_selection": { - "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "refresh_selection": { - "description": "A list of tables to update without fullRefresh.", + "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" } @@ -6073,12 +6211,12 @@ "x-since-version": "v0.229.0" }, "full_refresh_selection": { - "description": "A list of tables to update with fullRefresh.", + "description": "[Beta] A list of tables to update with fullRefresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "parameters": { - "description": "Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", + "description": "[Beta] Key/value-map of parameters passed to the pipeline execution.\nLimited to 10k characters in total.", "$ref": "#/$defs/map/string", "x-since-version": "v1.2.0" }, @@ -6088,17 +6226,17 @@ "x-since-version": "v0.229.0" }, "refresh_flow_selection": { - "description": "Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", + "description": "[Beta] Flow names to selectively refresh. These are unioned with other selective refresh\noptions (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "refresh_selection": { - "description": "A list of tables to update without fullRefresh.", + "description": "[Beta] A list of tables to update without fullRefresh.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" }, "reset_checkpoint_selection": { - "description": "A list of streaming flows to reset checkpoints without clearing data.", + "description": "[Beta] A list of streaming flows to reset checkpoints without clearing data.", "$ref": "#/$defs/slice/string", "x-since-version": "v1.1.0" } @@ -6112,27 +6250,27 @@ "type": "object", "properties": { "authentication_method": { - "description": "How the published Power BI model authenticates to Databricks", + "description": "[Public Preview] How the published Power BI model authenticates to Databricks", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod", "x-since-version": "v0.248.0" }, "model_name": { - "description": "The name of the Power BI model", + "description": "[Public Preview] The name of the Power BI model", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "overwrite_existing": { - "description": "Whether to overwrite existing Power BI models", + "description": "[Public Preview] Whether to overwrite existing Power BI models", "$ref": "#/$defs/bool", "x-since-version": "v0.248.0" }, "storage_mode": { - "description": "The default storage mode of the Power BI model", + "description": "[Public Preview] The default storage mode of the Power BI model", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode", "x-since-version": "v0.248.0" }, "workspace_name": { - "description": "The name of the Power BI workspace of the model", + "description": "[Public Preview] The name of the Power BI workspace of the model", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" } @@ -6143,22 +6281,22 @@ "type": "object", "properties": { "catalog": { - "description": "The catalog name in Databricks", + "description": "[Public Preview] The catalog name in Databricks", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "name": { - "description": "The table name in Databricks", + "description": "[Public Preview] The table name in Databricks", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "schema": { - "description": "The schema name in Databricks", + "description": "[Public Preview] The schema name in Databricks", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "storage_mode": { - "description": "The Power BI storage mode of the table", + "description": "[Public Preview] The Power BI storage mode of the table", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode", "x-since-version": "v0.248.0" } @@ -6169,27 +6307,27 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection to authenticate from Databricks to Power BI", + "description": "[Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" }, "power_bi_model": { - "description": "The semantic model to update", + "description": "[Public Preview] The semantic model to update", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiModel", "x-since-version": "v0.248.0" }, "refresh_after_update": { - "description": "Whether the model should be refreshed after the update", + "description": "[Public Preview] Whether the model should be refreshed after the update", "$ref": "#/$defs/bool", "x-since-version": "v0.248.0" }, "tables": { - "description": "The tables to be exported to Power BI", + "description": "[Public Preview] The tables to be exported to Power BI", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable", "x-since-version": "v0.248.0" }, "warehouse_id": { - "description": "The SQL warehouse ID to use as the Power BI data source", + "description": "[Public Preview] The SQL warehouse ID to use as the Power BI data source", "$ref": "#/$defs/string", "x-since-version": "v0.248.0" } @@ -6200,14 +6338,14 @@ "type": "object", "properties": { "main": { - "description": "Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", + "description": "[Private Preview] Fully qualified name of the main class or function.\nFor example, `my_project.my_function` or `my_project.MyOperator`.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "parameters": { - "description": "An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", + "description": "[Private Preview] An ordered list of task parameters.\nTODO(JOBS-30885): Add limits for parameters.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTaskParameter", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -6220,12 +6358,14 @@ "type": "object", "properties": { "name": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "value": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -6288,13 +6428,21 @@ "AT_LEAST_ONE_SUCCESS", "ALL_FAILED", "AT_LEAST_ONE_FAILED" + ], + "enumDescriptions": [ + "All dependencies have executed and succeeded", + "All dependencies have been completed", + "None of the dependencies have failed and at least one was executed", + "At least one dependency has succeeded", + "ALl dependencies have failed", + "At least one dependency failed" ] }, "jobs.RunJobTask": { "type": "object", "properties": { "dbt_commands": { - "description": "An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -6303,7 +6451,7 @@ "deprecated": true }, "jar_params": { - "description": "A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -6322,7 +6470,7 @@ "x-since-version": "v0.229.0" }, "notebook_params": { - "description": "A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.", + "description": "[Private Preview] A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -6336,6 +6484,7 @@ "x-since-version": "v0.229.0" }, "python_named_params": { + "description": "[Private Preview]", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -6344,7 +6493,7 @@ "deprecated": true }, "python_params": { - "description": "A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", + "description": "[Private Preview] A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -6353,7 +6502,7 @@ "deprecated": true }, "spark_submit_params": { - "description": "A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", + "description": "[Private Preview] A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -6362,7 +6511,7 @@ "deprecated": true }, "sql_params": { - "description": "A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -6382,6 +6531,10 @@ "enum": [ "WORKSPACE", "GIT" + ], + "enumDescriptions": [ + "SQL file is located in \u003cDatabricks\u003e workspace.", + "SQL file is located in cloud Git provider." ] }, "jobs.SparkJarTask": { @@ -6607,6 +6760,11 @@ "DIRECT_QUERY", "IMPORT", "DUAL" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "jobs.Subscription": { @@ -6676,7 +6834,7 @@ "type": "object", "properties": { "alert_task": { - "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", + "description": "[Public Preview] The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask", "x-since-version": "v0.296.0" }, @@ -6686,7 +6844,7 @@ "x-since-version": "v0.237.0" }, "compute": { - "description": "Task level compute configuration.", + "description": "[Beta] Task level compute configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", "x-since-version": "v0.288.0" }, @@ -6701,7 +6859,7 @@ "x-since-version": "v0.248.0" }, "dbt_cloud_task": { - "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", + "description": "[Private Preview] Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtCloudTask", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -6710,6 +6868,7 @@ "deprecated": true }, "dbt_platform_task": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -6761,6 +6920,7 @@ "x-since-version": "v0.229.0" }, "gen_ai_compute_task": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -6811,12 +6971,12 @@ "x-since-version": "v0.229.0" }, "power_bi_task": { - "description": "The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", + "description": "[Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask", "x-since-version": "v0.248.0" }, "python_operator_task": { - "description": "The task runs a Python operator task.", + "description": "[Private Preview] The task runs a Python operator task.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PythonOperatorTask", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -6930,7 +7090,7 @@ "x-since-version": "v0.229.0" }, "on_streaming_backlog_exceeded": { - "description": "A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", + "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.229.0" }, @@ -6980,6 +7140,7 @@ "x-since-version": "v0.229.0" }, "model": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7034,7 +7195,7 @@ "x-since-version": "v0.229.0" }, "on_streaming_backlog_exceeded": { - "description": "An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property.", + "description": "[Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", "x-since-version": "v0.229.0" }, @@ -7105,12 +7266,12 @@ "description": "Policy for auto full refresh.", "properties": { "enabled": { - "description": "(Required, Mutable) Whether to enable auto full refresh or not.", + "description": "[Public Preview] (Required, Mutable) Whether to enable auto full refresh or not.", "$ref": "#/$defs/bool", "x-since-version": "v0.285.0" }, "min_interval_hours": { - "description": "(Optional, Mutable) Specify the minimum interval in hours between the timestamp\nat which a table was last full refreshed and the current timestamp for triggering auto full\nIf unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours.", + "description": "[Public Preview] (Optional, Mutable) Specify the minimum interval in hours between the timestamp\nat which a table was last full refreshed and the current timestamp for triggering auto full\nIf unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours.", "$ref": "#/$defs/int", "x-since-version": "v0.285.0" } @@ -7125,7 +7286,7 @@ "description": "Confluence specific options for ingestion", "properties": { "include_confluence_spaces": { - "description": "(Optional) Spaces to filter Confluence data on", + "description": "[Public Preview] (Optional) Spaces to filter Confluence data on", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" } @@ -7136,7 +7297,7 @@ "type": "object", "properties": { "source_catalog": { - "description": "Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", + "description": "[Private Preview] Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7150,68 +7311,71 @@ "description": "Wrapper message for source-specific options to support multiple connector types", "properties": { "confluence_options": { - "description": "Confluence specific options for ingestion", + "description": "[Public Preview] Confluence specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions", "x-since-version": "v0.299.2" }, "gdrive_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "google_ads_options": { - "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", + "description": "[Private Preview] Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "jira_options": { - "description": "Jira specific options for ingestion", + "description": "[Beta] Jira specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", "x-since-version": "v0.299.2" }, "kafka_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.KafkaOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "meta_ads_options": { - "description": "Meta Marketing (Meta Ads) specific options for ingestion", + "description": "[Beta] Meta Marketing (Meta Ads) specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", "x-since-version": "v0.299.2" }, "outlook_options": { - "description": "Outlook specific options for ingestion", + "description": "[Private Preview] Outlook specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", "x-databricks-preview": "PRIVATE", "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", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "smartsheet_options": { - "description": "Smartsheet specific options for ingestion", + "description": "[Private Preview] Smartsheet specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "tiktok_ads_options": { - "description": "TikTok Ads specific options for ingestion", + "description": "[Private Preview] TikTok Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "zendesk_support_options": { - "description": "Zendesk Support specific options for ingestion", + "description": "[Private Preview] Zendesk Support specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7226,6 +7390,10 @@ "enum": [ "CDC", "QUERY_BASED" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "pipelines.CronTrigger": { @@ -7247,17 +7415,17 @@ "description": "Location of staged data storage", "properties": { "catalog_name": { - "description": "(Required, Immutable) The name of the catalog for the connector's staging storage location.", + "description": "[Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location.", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" }, "schema_name": { - "description": "(Required, Immutable) The name of the schema for the connector's staging storage location.", + "description": "[Beta] (Required, Immutable) The name of the schema for the connector's staging storage location.", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" }, "volume_name": { - "description": "(Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", + "description": "[Beta] (Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", "$ref": "#/$defs/string", "x-since-version": "v0.296.0" } @@ -7279,6 +7447,15 @@ "FRIDAY", "SATURDAY", "SUNDAY" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "pipelines.DeploymentKind": { @@ -7314,21 +7491,21 @@ "type": "object", "properties": { "modified_after": { - "description": "Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", + "description": "[Private Preview] Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "modified_before": { - "description": "Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", + "description": "[Private Preview] Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "path_filter": { - "description": "Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", + "description": "[Private Preview] Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7341,72 +7518,77 @@ "type": "object", "properties": { "corrupt_record_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_filters": { - "description": "Generic options", + "description": "[Private Preview] Generic options", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format": { - "description": "required for TableSpec", + "description": "[Private Preview] required for TableSpec", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format_options": { - "description": "Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", + "description": "[Private Preview] Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "ignore_corrupt_files": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "infer_column_types": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "reader_case_sensitive": { - "description": "Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", + "description": "[Private Preview] Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "rescued_data_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "schema_evolution_mode": { - "description": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", + "description": "[Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "schema_hints": { - "description": "Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", + "description": "[Private Preview] Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "single_variant_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7426,6 +7608,16 @@ "PARQUET", "AVRO", "ORC" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.FileIngestionOptionsSchemaEvolutionMode": { @@ -7437,6 +7629,13 @@ "RESCUE", "FAIL_ON_NEW_COLUMNS", "NONE" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.FileLibrary": { @@ -7470,7 +7669,7 @@ "type": "object", "properties": { "manager_account_id": { - "description": "(Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", + "description": "[Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7484,21 +7683,21 @@ "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "properties": { "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", + "description": "[Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "manager_account_id": { - "description": "(Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", + "description": "[Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7514,19 +7713,21 @@ "type": "object", "properties": { "entity_type": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", "x-databricks-preview": "PRIVATE", "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", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "url": { - "description": "Google Drive URL.", + "description": "[Private Preview] Google Drive URL.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7541,23 +7742,28 @@ "FILE", "FILE_METADATA", "PERMISSION" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.IngestionConfig": { "type": "object", "properties": { "report": { - "description": "Select a specific source report.", + "description": "[Public Preview] Select a specific source report.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec", "x-since-version": "v0.231.0" }, "schema": { - "description": "Select all tables from a specific source schema.", + "description": "[Public Preview] Select all tables from a specific source schema.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec", "x-since-version": "v0.229.0" }, "table": { - "description": "Select a specific source table.", + "description": "[Public Preview] Select a specific source table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec", "x-since-version": "v0.229.0" } @@ -7568,7 +7774,7 @@ "type": "object", "properties": { "connection_id": { - "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "description": "[Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7577,35 +7783,35 @@ "deprecated": true }, "connection_name": { - "description": "Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "description": "[Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.234.0" }, "connection_parameters": { - "description": "Optional, Internal. Parameters required to establish an initial connection with the source.", + "description": "[Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "gateway_storage_catalog": { - "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", + "description": "[Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "gateway_storage_name": { - "description": "Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", + "description": "[Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "gateway_storage_schema": { - "description": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.", + "description": "[Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7623,53 +7829,54 @@ "type": "object", "properties": { "connection_name": { - "description": "The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with\nboth connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle,\n(connector_type = QUERY_BASED OR connector_type = CDC).\nIf connection name corresponds to database connectors like Oracle, and connector_type is not provided then\nconnector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion\npipeline.\nUnder certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed\nIngestion Pipeline with Gateway pipeline.", + "description": "[Public Preview] The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with\nboth connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle,\n(connector_type = QUERY_BASED OR connector_type = CDC).\nIf connection name corresponds to database connectors like Oracle, and connector_type is not provided then\nconnector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion\npipeline.\nUnder certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed\nIngestion Pipeline with Gateway pipeline.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "connector_type": { - "description": "(Optional) Connector Type for sources. Ex: CDC, Query Based.", + "description": "[Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", "x-since-version": "v0.296.0" }, "data_staging_options": { - "description": "(Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", + "description": "[Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions", "x-since-version": "v0.296.0" }, "full_refresh_window": { - "description": "(Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", + "description": "[Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow", "x-since-version": "v0.285.0" }, "ingest_from_uc_foreign_catalog": { - "description": "Immutable. If set to true, the pipeline will ingest tables from the\nUC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.\nThe `source_catalog` fields in objects of IngestionConfig are interpreted as\nthe UC foreign catalogs to ingest from.", + "description": "[Public Preview] Immutable. If set to true, the pipeline will ingest tables from the\nUC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.\nThe `source_catalog` fields in objects of IngestionConfig are interpreted as\nthe UC foreign catalogs to ingest from.", "$ref": "#/$defs/bool", "x-since-version": "v0.279.0" }, "ingestion_gateway_id": { - "description": "Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database.\nThis is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC).\nUnder certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc\nManaged Ingestion Pipeline.", + "description": "[Public Preview] Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database.\nThis is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC).\nUnder certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc\nManaged Ingestion Pipeline.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "netsuite_jar_path": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.271.0" }, "objects": { - "description": "Required. Settings specifying tables to replicate and the destination for the replicated tables.", + "description": "[Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig", "x-since-version": "v0.229.0" }, "source_configurations": { - "description": "Top-level source configurations", + "description": "[Public Preview] Top-level source configurations", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig", "x-since-version": "v0.267.0" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.", + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", "x-since-version": "v0.229.0" } @@ -7681,17 +7888,17 @@ "description": "Configurations that are only applicable for query-based ingestion connectors.", "properties": { "cursor_columns": { - "description": "The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", + "description": "[Public Preview] The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.264.0" }, "deletion_condition": { - "description": "Specifies a SQL WHERE condition that specifies that the source row has been deleted.\nThis is sometimes referred to as \"soft-deletes\".\nFor example: \"Operation = 'DELETE'\" or \"is_deleted = true\".\nThis field is orthogonal to `hard_deletion_sync_interval_in_seconds`,\none for soft-deletes and the other for hard-deletes.\nSee also the hard_deletion_sync_min_interval_in_seconds field for\nhandling of \"hard deletes\" where the source rows are physically removed from the table.", + "description": "[Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted.\nThis is sometimes referred to as \"soft-deletes\".\nFor example: \"Operation = 'DELETE'\" or \"is_deleted = true\".\nThis field is orthogonal to `hard_deletion_sync_interval_in_seconds`,\none for soft-deletes and the other for hard-deletes.\nSee also the hard_deletion_sync_min_interval_in_seconds field for\nhandling of \"hard deletes\" where the source rows are physically removed from the table.", "$ref": "#/$defs/string", "x-since-version": "v0.264.0" }, "hard_deletion_sync_min_interval_in_seconds": { - "description": "Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", + "description": "[Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", "$ref": "#/$defs/int64", "x-since-version": "v0.264.0" } @@ -7702,7 +7909,7 @@ "type": "object", "properties": { "incremental": { - "description": "(Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", + "description": "[Private Preview] (Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7711,14 +7918,14 @@ "deprecated": true }, "parameters": { - "description": "Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", + "description": "[Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.271.0" }, "report_parameters": { - "description": "(Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", + "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -7733,14 +7940,14 @@ "type": "object", "properties": { "key": { - "description": "Key for the report parameter, can be a column name or other metadata", + "description": "[Private Preview] Key for the report parameter, can be a column name or other metadata", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.271.0" }, "value": { - "description": "Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", + "description": "[Private Preview] Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7772,6 +7979,28 @@ "META_MARKETING", "ZENDESK", "FOREIGN_CATALOG" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Private Preview]", + "[Beta]", + "[Public Preview]", + "[Beta]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.JiraConnectorOptions": { @@ -7779,7 +8008,7 @@ "description": "Jira specific options for ingestion", "properties": { "include_jira_spaces": { - "description": "(Optional) Projects to filter Jira data on", + "description": "[Beta] (Optional) Projects to filter Jira data on", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" } @@ -7790,35 +8019,35 @@ "type": "object", "properties": { "as_variant": { - "description": "Parse the entire value as a single Variant column.", + "description": "[Private Preview] Parse the entire value as a single Variant column.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema": { - "description": "Inline schema string for JSON parsing (Spark DDL format).", + "description": "[Private Preview] Inline schema string for JSON parsing (Spark DDL format).", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_evolution_mode": { - "description": "(Optional) Schema evolution mode for schema inference.", + "description": "[Private Preview] (Optional) Schema evolution mode for schema inference.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_file_path": { - "description": "Path to a schema file (.ddl).", + "description": "[Private Preview] Path to a schema file (.ddl).", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "schema_hints": { - "description": "(Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", + "description": "[Private Preview] (Optional) Schema hints as a comma-separated string of \"column_name type\" pairs.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7831,49 +8060,49 @@ "type": "object", "properties": { "client_config": { - "description": "Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", + "description": "[Private Preview] Undocumented backdoor mechanism for overriding parameters\nto pass to the Kafka client.\nThis is not supported and may break at any time.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "key_transformer": { - "description": "(Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", + "description": "[Private Preview] (Optional) Transformer for the message key.\nIf not specified, the key is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "max_offsets_per_trigger": { - "description": "Internal option to control the maximum number of offsets to process per trigger.", + "description": "[Private Preview] Internal option to control the maximum number of offsets to process per trigger.", "$ref": "#/$defs/int64", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "starting_offset": { - "description": "(Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", + "description": "[Private Preview] (Optional) Where to begin reading when no checkpoint exists.\nValid values: \"latest\" and \"earliest\". Defaults to \"latest\".", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "topic_pattern": { - "description": "Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", + "description": "[Private Preview] Java regex pattern to subscribe to matching topics.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "topics": { - "description": "Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", + "description": "[Private Preview] Topics to subscribe to.\nOnly one of topics or topic_pattern must be specified.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v1.1.0" }, "value_transformer": { - "description": "(Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", + "description": "[Private Preview] (Optional) Transformer for the message value.\nIf not specified, the value is left as raw bytes.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.Transformer", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -7891,42 +8120,42 @@ "description": "Meta Marketing (Meta Ads) specific options for ingestion", "properties": { "action_attribution_windows": { - "description": "(Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", + "description": "[Beta] (Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" }, "action_breakdowns": { - "description": "(Optional) Action breakdowns to configure for data aggregation", + "description": "[Beta] (Optional) Action breakdowns to configure for data aggregation", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" }, "action_report_time": { - "description": "(Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", + "description": "[Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", "$ref": "#/$defs/string", "x-since-version": "v0.299.2" }, "breakdowns": { - "description": "(Optional) Breakdowns to configure for data aggregation", + "description": "[Beta] (Optional) Breakdowns to configure for data aggregation", "$ref": "#/$defs/slice/string", "x-since-version": "v0.299.2" }, "custom_insights_lookback_window": { - "description": "(Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", + "description": "[Beta] (Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", "$ref": "#/$defs/int", "x-since-version": "v0.299.2" }, "level": { - "description": "(Optional) Granularity of data to pull (account, ad, adset, campaign)", + "description": "[Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign)", "$ref": "#/$defs/string", "x-since-version": "v0.299.2" }, "start_date": { - "description": "(Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested", + "description": "[Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested", "$ref": "#/$defs/string", "x-since-version": "v0.299.2" }, "time_increment": { - "description": "(Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", + "description": "[Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", "$ref": "#/$defs/string", "x-since-version": "v0.299.2" } @@ -7965,17 +8194,17 @@ "description": "Proto representing a window", "properties": { "days_of_week": { - "description": "Days of week in which the window is allowed to happen\nIf not specified all days of the week will be used.", + "description": "[Public Preview] Days of week in which the window is allowed to happen\nIf not specified all days of the week will be used.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", "x-since-version": "v0.285.0" }, "start_hour": { - "description": "An integer between 0 and 23 denoting the start hour for the window in the 24-hour day.", + "description": "[Public Preview] An integer between 0 and 23 denoting the start hour for the window in the 24-hour day.", "$ref": "#/$defs/int", "x-since-version": "v0.285.0" }, "time_zone_id": { - "description": "Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", + "description": "[Public Preview] Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", "$ref": "#/$defs/string", "x-since-version": "v0.285.0" } @@ -7993,6 +8222,12 @@ "NON_INLINE_ONLY", "INLINE_ONLY", "NONE" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.OutlookBodyFormat": { @@ -8001,6 +8236,10 @@ "enum": [ "TEXT_HTML", "TEXT_PLAIN" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.OutlookOptions": { @@ -8008,21 +8247,21 @@ "description": "Outlook specific options for ingestion", "properties": { "attachment_mode": { - "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", + "description": "[Private Preview] (Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "body_format": { - "description": "(Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", + "description": "[Private Preview] (Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "folder_filter": { - "description": "Deprecated. Use include_folders instead.", + "description": "[Private Preview] Deprecated. Use include_folders instead.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -8031,35 +8270,35 @@ "deprecated": true }, "include_folders": { - "description": "(Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", + "description": "[Private Preview] (Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_mailboxes": { - "description": "(Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", + "description": "[Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_senders": { - "description": "(Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", + "description": "[Private Preview] (Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_subjects": { - "description": "(Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", + "description": "[Private Preview] (Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "sender_filter": { - "description": "Deprecated. Use include_senders instead.", + "description": "[Private Preview] Deprecated. Use include_senders instead.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -8068,14 +8307,14 @@ "deprecated": true }, "start_date": { - "description": "(Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", + "description": "[Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "subject_filter": { - "description": "Deprecated. Use include_subjects instead.", + "description": "[Private Preview] Deprecated. Use include_subjects instead.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "deprecationMessage": "This field is deprecated", @@ -8090,7 +8329,7 @@ "type": "object", "properties": { "include": { - "description": "The source code to include for pipelines", + "description": "[Public Preview] The source code to include for pipelines", "$ref": "#/$defs/string", "x-since-version": "v0.252.0" } @@ -8235,7 +8474,7 @@ "type": "object", "properties": { "deployment_id": { - "description": "ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", + "description": "[Private Preview] ID of the deployment that manages this pipeline. Only set when `kind` is\n`BUNDLE`. Used to look up deployment metadata from the Deployment\nMetadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8252,7 +8491,7 @@ "x-since-version": "v0.229.0" }, "version_id": { - "description": "ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", + "description": "[Private Preview] ID of the version of the deployment that produced this pipeline. Only\nset when `kind` is `BUNDLE`. Identifies a specific snapshot of the\ndeployment in the Deployment Metadata service.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8273,19 +8512,19 @@ "x-since-version": "v0.229.0" }, "glob": { - "description": "The unified field to include source codes.\nEach entry can be a notebook path, a file path, or a folder path that ends `/**`.\nThis field cannot be used together with `notebook` or `file`.", + "description": "[Public Preview] The unified field to include source codes.\nEach entry can be a notebook path, a file path, or a folder path that ends `/**`.\nThis field cannot be used together with `notebook` or `file`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern", "x-since-version": "v0.252.0" }, "jar": { - "description": "URI of the jar to be installed. Currently only DBFS is supported.", + "description": "[Private Preview] URI of the jar to be installed. Currently only DBFS is supported.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "maven": { - "description": "Specification of a maven library to be installed.", + "description": "[Private Preview] Specification of a maven library to be installed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8335,12 +8574,12 @@ "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip dependencies are supported.", "properties": { "dependencies": { - "description": "List of pip dependencies, as supported by the version of pip in this environment.\nEach dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/\nAllowed dependency could be \u003crequirement specifier\u003e, \u003carchive url/path\u003e, \u003clocal project path\u003e(WSFS or Volumes in Databricks), \u003cvcs project url\u003e", + "description": "[Public Preview] List of pip dependencies, as supported by the version of pip in this environment.\nEach dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/\nAllowed dependency could be \u003crequirement specifier\u003e, \u003carchive url/path\u003e, \u003clocal project path\u003e(WSFS or Volumes in Databricks), \u003cvcs project url\u003e", "$ref": "#/$defs/slice/string", "x-since-version": "v0.257.0" }, "environment_version": { - "description": "The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", + "description": "[Private Preview] The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8354,7 +8593,7 @@ "description": "PG-specific catalog-level configuration parameters", "properties": { "slot_config": { - "description": "Optional. The Postgres slot configuration to use for logical replication", + "description": "[Public Preview] Optional. The Postgres slot configuration to use for logical replication", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig", "x-since-version": "v0.267.0" } @@ -8366,12 +8605,12 @@ "description": "PostgresSlotConfig contains the configuration for a Postgres logical replication slot", "properties": { "publication_name": { - "description": "The name of the publication to use for the Postgres source", + "description": "[Public Preview] The name of the publication to use for the Postgres source", "$ref": "#/$defs/string", "x-since-version": "v0.267.0" }, "slot_name": { - "description": "The name of the logical replication slot to use for the Postgres source", + "description": "[Public Preview] The name of the logical replication slot to use for the Postgres source", "$ref": "#/$defs/string", "x-since-version": "v0.267.0" } @@ -8382,27 +8621,27 @@ "type": "object", "properties": { "destination_catalog": { - "description": "Required. Destination catalog to store table.", + "description": "[Public Preview] Required. Destination catalog to store table.", "$ref": "#/$defs/string", "x-since-version": "v0.231.0" }, "destination_schema": { - "description": "Required. Destination schema to store table.", + "description": "[Public Preview] Required. Destination schema to store table.", "$ref": "#/$defs/string", "x-since-version": "v0.231.0" }, "destination_table": { - "description": "Required. Destination table name. The pipeline fails if a table with that name already exists.", + "description": "[Public Preview] Required. Destination table name. The pipeline fails if a table with that name already exists.", "$ref": "#/$defs/string", "x-since-version": "v0.231.0" }, "source_url": { - "description": "Required. Report URL in the source system.", + "description": "[Public Preview] Required. Report URL in the source system.", "$ref": "#/$defs/string", "x-since-version": "v0.231.0" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object.", + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", "x-since-version": "v0.231.0" } @@ -8418,21 +8657,21 @@ "type": "object", "properties": { "days_of_week": { - "description": "Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", + "description": "[Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.234.0" }, "start_hour": { - "description": "An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", + "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.234.0" }, "time_zone_id": { - "description": "Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", + "description": "[Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8465,32 +8704,32 @@ "type": "object", "properties": { "connector_options": { - "description": "(Optional) Source Specific Connector Options", + "description": "[Public Preview] (Optional) Source Specific Connector Options", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", "x-since-version": "v0.298.0" }, "destination_catalog": { - "description": "Required. Destination catalog to store tables.", + "description": "[Public Preview] Required. Destination catalog to store tables.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "destination_schema": { - "description": "Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists.", + "description": "[Public Preview] Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "source_catalog": { - "description": "The source catalog name. Might be optional depending on the type of source.", + "description": "[Public Preview] The source catalog name. Might be optional depending on the type of source.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "source_schema": { - "description": "Required. Schema name in the source database.", + "description": "[Public Preview] Required. Schema name in the source database.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object.", + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", "x-since-version": "v0.229.0" } @@ -8506,21 +8745,21 @@ "type": "object", "properties": { "entity_type": { - "description": "(Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", + "description": "[Private Preview] (Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_ingestion_options": { - "description": "(Optional) File ingestion options for processing files.", + "description": "[Private Preview] (Optional) File ingestion options for processing files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "url": { - "description": "Required. The SharePoint URL.", + "description": "[Private Preview] Required. The SharePoint URL.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8536,6 +8775,12 @@ "FILE_METADATA", "PERMISSION", "LIST" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.SmartsheetOptions": { @@ -8543,7 +8788,7 @@ "description": "Smartsheet specific options for ingestion", "properties": { "enforce_schema": { - "description": "(Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", + "description": "[Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8557,12 +8802,12 @@ "description": "SourceCatalogConfig contains catalog-level custom configuration parameters for each source", "properties": { "postgres": { - "description": "Postgres-specific catalog-level configuration parameters", + "description": "[Public Preview] Postgres-specific catalog-level configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig", "x-since-version": "v0.267.0" }, "source_catalog": { - "description": "Source catalog name", + "description": "[Public Preview] Source catalog name", "$ref": "#/$defs/string", "x-since-version": "v0.267.0" } @@ -8573,11 +8818,12 @@ "type": "object", "properties": { "catalog": { - "description": "Catalog-level source configuration parameters", + "description": "[Public Preview] Catalog-level source configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig", "x-since-version": "v0.267.0" }, "google_ads_config": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8590,42 +8836,42 @@ "type": "object", "properties": { "connector_options": { - "description": "(Optional) Source Specific Connector Options", + "description": "[Public Preview] (Optional) Source Specific Connector Options", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", "x-since-version": "v0.298.0" }, "destination_catalog": { - "description": "Required. Destination catalog to store table.", + "description": "[Public Preview] Required. Destination catalog to store table.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "destination_schema": { - "description": "Required. Destination schema to store table.", + "description": "[Public Preview] Required. Destination schema to store table.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "destination_table": { - "description": "Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used.", + "description": "[Public Preview] Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "source_catalog": { - "description": "Source catalog name. Might be optional depending on the type of source.", + "description": "[Public Preview] Source catalog name. Might be optional depending on the type of source.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "source_schema": { - "description": "Schema name in the source database. Might be optional depending on the type of source.", + "description": "[Public Preview] Schema name in the source database. Might be optional depending on the type of source.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "source_table": { - "description": "Required. Table name in the source database.", + "description": "[Public Preview] Required. Table name in the source database.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec.", + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", "x-since-version": "v0.229.0" } @@ -8641,53 +8887,54 @@ "type": "object", "properties": { "auto_full_refresh_policy": { - "description": "(Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", + "description": "[Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy", "x-since-version": "v0.285.0" }, "exclude_columns": { - "description": "A list of column names to be excluded for the ingestion.\nWhen not specified, include_columns fully controls what columns to be ingested.\nWhen specified, all other columns including future ones will be automatically included for ingestion.\nThis field in mutually exclusive with `include_columns`.", + "description": "[Public Preview] A list of column names to be excluded for the ingestion.\nWhen not specified, include_columns fully controls what columns to be ingested.\nWhen specified, all other columns including future ones will be automatically included for ingestion.\nThis field in mutually exclusive with `include_columns`.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.251.0" }, "include_columns": { - "description": "A list of column names to be included for the ingestion.\nWhen not specified, all columns except ones in exclude_columns will be included. Future\ncolumns will be automatically included.\nWhen specified, all other future columns will be automatically excluded from ingestion.\nThis field in mutually exclusive with `exclude_columns`.", + "description": "[Public Preview] A list of column names to be included for the ingestion.\nWhen not specified, all columns except ones in exclude_columns will be included. Future\ncolumns will be automatically included.\nWhen specified, all other future columns will be automatically excluded from ingestion.\nThis field in mutually exclusive with `exclude_columns`.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.251.0" }, "primary_keys": { - "description": "The primary key of the table used to apply changes.", + "description": "[Public Preview] The primary key of the table used to apply changes.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.229.0" }, "query_based_connector_config": { - "description": "Configurations that are only applicable for query-based ingestion connectors.", + "description": "[Public Preview] Configurations that are only applicable for query-based ingestion connectors.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", "x-since-version": "v0.264.0" }, "row_filter": { - "description": "(Optional, Immutable) The row filter condition to be applied to the table.\nIt must not contain the WHERE keyword, only the actual filter condition.\nIt must be in DBSQL format.", + "description": "[Public Preview] (Optional, Immutable) The row filter condition to be applied to the table.\nIt must not contain the WHERE keyword, only the actual filter condition.\nIt must be in DBSQL format.", "$ref": "#/$defs/string", "x-since-version": "v0.283.0" }, "salesforce_include_formula_fields": { - "description": "If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", + "description": "[Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "scd_type": { - "description": "The SCD type to use to ingest the table.", + "description": "[Public Preview] The SCD type to use to ingest the table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType", "x-since-version": "v0.229.0" }, "sequence_by": { - "description": "The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order.", + "description": "[Public Preview] The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order.", "$ref": "#/$defs/slice/string", "x-since-version": "v0.231.0" }, "workday_report_parameters": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8703,6 +8950,11 @@ "SCD_TYPE_1", "SCD_TYPE_2", "APPEND_ONLY" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "pipelines.TikTokAdsOptions": { @@ -8710,49 +8962,49 @@ "description": "TikTok Ads specific options for ingestion", "properties": { "data_level": { - "description": "(Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "dimensions": { - "description": "(Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", + "description": "[Private Preview] (Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", + "description": "[Private Preview] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", "$ref": "#/$defs/int", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "metrics": { - "description": "(Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", + "description": "[Private Preview] (Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "query_lifetime": { - "description": "(Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", + "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "report_type": { - "description": "(Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", + "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8769,6 +9021,12 @@ "AUCTION_CAMPAIGN", "AUCTION_ADGROUP", "AUCTION_AD" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.TikTokAdsOptionsTikTokReportType": { @@ -8781,6 +9039,14 @@ "DSA", "BUSINESS_CENTER", "GMV_MAX" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.Transformer": { @@ -8788,13 +9054,14 @@ "description": "Specifies how to transform binary data into structured data.", "properties": { "format": { - "description": "Required: the wire format of the data.", + "description": "[Private Preview] Required: the wire format of the data.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TransformerFormat", "x-databricks-preview": "PRIVATE", "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", "doNotSuggest": true, @@ -8808,6 +9075,10 @@ "enum": [ "STRING", "JSON" + ], + "enumDescriptions": [ + "[Private Preview]", + "[Private Preview]" ] }, "pipelines.ZendeskSupportOptions": { @@ -8815,7 +9086,7 @@ "description": "Zendesk Support specific options for ingestion", "properties": { "start_date": { - "description": "(Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", + "description": "[Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", "doNotSuggest": true, @@ -8828,17 +9099,17 @@ "type": "object", "properties": { "enable_readable_secondaries": { - "description": "Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1.", + "description": "[Beta] Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1.", "$ref": "#/$defs/bool", "x-since-version": "v0.290.0" }, "max": { - "description": "The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec.", + "description": "[Beta] The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec.", "$ref": "#/$defs/int", "x-since-version": "v0.290.0" }, "min": { - "description": "The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1.", + "description": "[Beta] The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1.", "$ref": "#/$defs/int", "x-since-version": "v0.290.0" } @@ -8854,7 +9125,7 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "pg_settings": { - "description": "A raw representation of Postgres settings.", + "description": "[Beta] A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", "x-since-version": "v0.287.0" } @@ -8867,23 +9138,27 @@ "enum": [ "ENDPOINT_TYPE_READ_WRITE", "ENDPOINT_TYPE_READ_ONLY" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "postgres.NewPipelineSpec": { "type": "object", "properties": { "budget_policy_id": { - "description": "Budget policy to set on the newly created pipeline.", + "description": "[Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "storage_catalog": { - "description": "UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", + "description": "[Beta] UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" }, "storage_schema": { - "description": "UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", + "description": "[Beta] UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", "$ref": "#/$defs/string", "x-since-version": "v1.0.0" } @@ -8894,12 +9169,12 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", + "description": "[Beta] The key of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.290.0" }, "value": { - "description": "The value of the custom tag.", + "description": "[Beta] The value of the custom tag.", "$ref": "#/$defs/string", "x-since-version": "v0.290.0" } @@ -8911,27 +9186,27 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "autoscaling_limit_max_cu": { - "description": "The maximum number of Compute Units. Minimum value is 0.5.", + "description": "[Beta] The maximum number of Compute Units. Minimum value is 0.5.", "$ref": "#/$defs/float64", "x-since-version": "v0.287.0" }, "autoscaling_limit_min_cu": { - "description": "The minimum number of Compute Units. Minimum value is 0.5.", + "description": "[Beta] The minimum number of Compute Units. Minimum value is 0.5.", "$ref": "#/$defs/float64", "x-since-version": "v0.287.0" }, "no_suspension": { - "description": "When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", + "description": "[Beta] When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", "$ref": "#/$defs/bool", "x-since-version": "v0.287.0" }, "pg_settings": { - "description": "A raw representation of Postgres settings.", + "description": "[Beta] A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", "x-since-version": "v0.287.0" }, "suspend_timeout_duration": { - "description": "Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", + "description": "[Beta] Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration", "x-since-version": "v0.287.0" } @@ -8945,6 +9220,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]", + "[Beta]" ] }, "serving.Ai21LabsConfig": { @@ -8972,7 +9252,7 @@ "x-since-version": "v0.246.0" }, "guardrails": { - "description": "Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", + "description": "[Public Preview] Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails", "x-since-version": "v0.230.0" }, @@ -8998,24 +9278,24 @@ "type": "object", "properties": { "invalid_keywords": { - "description": "List of invalid keywords.\nAI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.", + "description": "[Public Preview] List of invalid keywords.\nAI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.", "$ref": "#/$defs/slice/string", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.230.0", "deprecated": true }, "pii": { - "description": "Configuration for guardrail PII filter.", + "description": "[Public Preview] Configuration for guardrail PII filter.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior", "x-since-version": "v0.230.0" }, "safety": { - "description": "Indicates whether the safety filter is enabled.", + "description": "[Public Preview] Indicates whether the safety filter is enabled.", "$ref": "#/$defs/bool", "x-since-version": "v0.230.0" }, "valid_topics": { - "description": "The list of allowed topics.\nGiven a chat request, this guardrail flags the request if its topic is not in the allowed topics.", + "description": "[Public Preview] The list of allowed topics.\nGiven a chat request, this guardrail flags the request if its topic is not in the allowed topics.", "$ref": "#/$defs/slice/string", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.230.0", @@ -9028,7 +9308,7 @@ "type": "object", "properties": { "behavior": { - "description": "Configuration for input guardrail filters.", + "description": "[Public Preview] Configuration for input guardrail filters.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior", "x-since-version": "v0.230.0" } @@ -9041,18 +9321,23 @@ "NONE", "BLOCK", "MASK" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "serving.AiGatewayGuardrails": { "type": "object", "properties": { "input": { - "description": "Configuration for input guardrail filters.", + "description": "[Public Preview] Configuration for input guardrail filters.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", "x-since-version": "v0.230.0" }, "output": { - "description": "Configuration for output guardrail filters.", + "description": "[Public Preview] Configuration for output guardrail filters.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", "x-since-version": "v0.230.0" } @@ -9126,12 +9411,21 @@ "endpoint", "user_group", "service_principal" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "serving.AiGatewayRateLimitRenewalPeriod": { "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[Public Preview]" ] }, "serving.AiGatewayUsageTrackingConfig": { @@ -9197,6 +9491,12 @@ "cohere", "ai21labs", "amazon" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "serving.AnthropicConfig": { @@ -9498,6 +9798,17 @@ "openai", "palm", "custom" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "serving.FallbackConfig": { @@ -9652,12 +9963,19 @@ "enum": [ "user", "endpoint" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, "serving.RateLimitRenewalPeriod": { "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[Public Preview]" ] }, "serving.Route": { @@ -9687,7 +10005,7 @@ "type": "object", "properties": { "burst_scaling_enabled": { - "description": "Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", + "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", "$ref": "#/$defs/bool", "x-since-version": "v0.288.0" }, @@ -9711,7 +10029,7 @@ "x-since-version": "v0.229.0" }, "instance_profile_arn": { - "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, @@ -9741,7 +10059,7 @@ "x-since-version": "v0.229.0" }, "provisioned_model_units": { - "description": "The number of model units provisioned.", + "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", "x-since-version": "v0.252.0" }, @@ -9767,7 +10085,7 @@ "type": "object", "properties": { "burst_scaling_enabled": { - "description": "Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", + "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", "$ref": "#/$defs/bool", "x-since-version": "v0.288.0" }, @@ -9777,7 +10095,7 @@ "x-since-version": "v0.229.0" }, "instance_profile_arn": { - "description": "ARN of the instance profile that the served entity uses to access AWS resources.", + "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", "$ref": "#/$defs/string", "x-since-version": "v0.229.0" }, @@ -9815,7 +10133,7 @@ "x-since-version": "v0.229.0" }, "provisioned_model_units": { - "description": "The number of model units provisioned.", + "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", "x-since-version": "v0.252.0" }, @@ -9852,6 +10170,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, "serving.ServingEndpointPermissionLevel": { @@ -9873,6 +10199,14 @@ "GPU_LARGE", "MULTIGPU_MEDIUM", "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, "serving.TrafficConfig": { @@ -9897,6 +10231,16 @@ "MIN", "MAX", "STDDEV" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "sql.AlertEvaluationState": { @@ -9907,6 +10251,12 @@ "TRIGGERED", "OK", "ERROR" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "sql.AlertLifecycleState": { @@ -9914,33 +10264,37 @@ "enum": [ "ACTIVE", "DELETED" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, "sql.AlertV2Evaluation": { "type": "object", "properties": { "comparison_operator": { - "description": "Operator used for comparison in alert evaluation.", + "description": "[Public Preview] Operator used for comparison in alert evaluation.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator", "x-since-version": "v0.279.0" }, "empty_result_state": { - "description": "Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", + "description": "[Public Preview] Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState", "x-since-version": "v0.279.0" }, "notification": { - "description": "User or Notification Destination to notify when alert is triggered.", + "description": "[Public Preview] User or Notification Destination to notify when alert is triggered.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Notification", "x-since-version": "v0.279.0" }, "source": { - "description": "Source column from result to use to evaluate alert", + "description": "[Public Preview] Source column from result to use to evaluate alert", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", "x-since-version": "v0.279.0" }, "threshold": { - "description": "Threshold to user for alert evaluation, can be a column or a value.", + "description": "[Public Preview] Threshold to user for alert evaluation, can be a column or a value.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Operand", "x-since-version": "v0.279.0" } @@ -9955,16 +10309,17 @@ "type": "object", "properties": { "notify_on_ok": { - "description": "Whether to notify alert subscribers when alert returns back to normal.", + "description": "[Public Preview] Whether to notify alert subscribers when alert returns back to normal.", "$ref": "#/$defs/bool", "x-since-version": "v0.279.0" }, "retrigger_seconds": { - "description": "Number of seconds an alert waits after being triggered before it is allowed to send another notification.\nIf set to 0 or omitted, the alert will not send any further notifications after the first trigger\nSetting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes.", + "description": "[Public Preview] Number of seconds an alert waits after being triggered before it is allowed to send another notification.\nIf set to 0 or omitted, the alert will not send any further notifications after the first trigger\nSetting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes.", "$ref": "#/$defs/int", "x-since-version": "v0.279.0" }, "subscriptions": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription", "x-since-version": "v0.279.0" } @@ -9975,10 +10330,12 @@ "type": "object", "properties": { "column": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", "x-since-version": "v0.279.0" }, "value": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue", "x-since-version": "v0.279.0" } @@ -9989,14 +10346,17 @@ "type": "object", "properties": { "aggregation": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation", "x-since-version": "v0.279.0" }, "display": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -10010,14 +10370,17 @@ "type": "object", "properties": { "bool_value": { + "description": "[Public Preview]", "$ref": "#/$defs/bool", "x-since-version": "v0.279.0" }, "double_value": { + "description": "[Public Preview]", "$ref": "#/$defs/float64", "x-since-version": "v0.279.0" }, "string_value": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -10028,12 +10391,12 @@ "type": "object", "properties": { "service_principal_name": { - "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", + "description": "[Public Preview] Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "user_name": { - "description": "The email of an active workspace user. Can only set this field to their own email.", + "description": "[Public Preview] The email of an active workspace user. Can only set this field to their own email.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -10044,10 +10407,12 @@ "type": "object", "properties": { "destination_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "user_email": { + "description": "[Public Preview]", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -10089,6 +10454,16 @@ "LESS_THAN_OR_EQUAL", "IS_NULL", "IS_NOT_NULL" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]", + "[Public Preview]" ] }, "sql.CreateWarehouseRequestWarehouseType": { @@ -10103,17 +10478,17 @@ "type": "object", "properties": { "pause_status": { - "description": "Indicate whether this schedule is paused or not.", + "description": "[Public Preview] Indicate whether this schedule is paused or not.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus", "x-since-version": "v0.279.0" }, "quartz_cron_schedule": { - "description": "A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", + "description": "[Public Preview] A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" }, "timezone_id": { - "description": "A Java timezone id. The schedule will be resolved using this timezone.\nThis will be combined with the quartz_cron_schedule to determine the schedule.\nSee https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.", + "description": "[Public Preview] A Java timezone id. The schedule will be resolved using this timezone.\nThis will be combined with the quartz_cron_schedule to determine the schedule.\nSee https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.", "$ref": "#/$defs/string", "x-since-version": "v0.279.0" } @@ -10153,6 +10528,10 @@ "enum": [ "UNPAUSED", "PAUSED" + ], + "enumDescriptions": [ + "[Public Preview]", + "[Public Preview]" ] }, "sql.SpotInstancePolicy": { @@ -10266,6 +10645,10 @@ "enum": [ "STORAGE_OPTIMIZED", "STANDARD" + ], + "enumDescriptions": [ + "[Public Preview]", + "" ] }, "vectorsearch.IndexSubtype": { @@ -10275,6 +10658,11 @@ "VECTOR", "FULL_TEXT", "HYBRID" + ], + "enumDescriptions": [ + "[Beta] Not supported. Use `HYBRID` instead.", + "[Beta] An index that uses full-text search without vector embeddings.", + "[Beta] An index that uses vector embeddings for similarity search and hybrid search." ] }, "vectorsearch.PipelineType": { @@ -10283,6 +10671,10 @@ "enum": [ "TRIGGERED", "CONTINUOUS" + ], + "enumDescriptions": [ + "If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.", + "If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh." ] }, "vectorsearch.VectorIndexType": { @@ -10291,6 +10683,10 @@ "enum": [ "DELTA_SYNC", "DIRECT_ACCESS" + ], + "enumDescriptions": [ + "An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes.", + "An index that supports direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates." ] }, "workspace.AzureKeyVaultSecretScopeMetadata": { diff --git a/libs/jsonschema/extension.go b/libs/jsonschema/extension.go index 0bc23afcb1b..ece93180f0c 100644 --- a/libs/jsonschema/extension.go +++ b/libs/jsonschema/extension.go @@ -48,6 +48,12 @@ type Extension struct { // from the generated Sphinx documentation. Preview string `json:"x-databricks-preview,omitempty"` + // EnumDescriptions is the parallel-array form emitted alongside Enum. VSCode + // renders these next to each enum value in autocomplete dropdowns. Each entry + // combines the per-value launch-stage label and textual description sourced + // from cli.json's enum_launch_stages and enum_descriptions. + EnumDescriptions []string `json:"enumDescriptions,omitempty"` + // This field is not in JSON schema spec, but it is supported in VSCode and in the Databricks Workspace // It is used to provide a rich description of the field in the hover tooltip. // https://code.visualstudio.com/docs/languages/json#_use-rich-formatting-in-hovers diff --git a/python/databricks/bundles/jobs/_models/alert_task.py b/python/databricks/bundles/jobs/_models/alert_task.py index b044b797780..66da2e9e4e7 100644 --- a/python/databricks/bundles/jobs/_models/alert_task.py +++ b/python/databricks/bundles/jobs/_models/alert_task.py @@ -19,23 +19,23 @@ class AlertTask: alert_id: VariableOrOptional[str] = None """ - The alert_id is the canonical identifier of the alert. + [Public Preview] The alert_id is the canonical identifier of the alert. """ subscribers: VariableOrList[AlertTaskSubscriber] = field(default_factory=list) """ - The subscribers receive alert evaluation result notifications after the alert task is completed. + [Public Preview] The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. """ warehouse_id: VariableOrOptional[str] = None """ - The warehouse_id identifies the warehouse settings used by the alert task. + [Public Preview] The warehouse_id identifies the warehouse settings used by the alert task. """ workspace_path: VariableOrOptional[str] = None """ - The workspace_path is the path to the alert file in the workspace. The path: + [Public Preview] The workspace_path is the path to the alert file in the workspace. The path: * must start with "/Workspace" * must be a normalized path. User has to select only one of alert_id or workspace_path to identify the alert. @@ -54,23 +54,23 @@ class AlertTaskDict(TypedDict, total=False): alert_id: VariableOrOptional[str] """ - The alert_id is the canonical identifier of the alert. + [Public Preview] The alert_id is the canonical identifier of the alert. """ subscribers: VariableOrList[AlertTaskSubscriberParam] """ - The subscribers receive alert evaluation result notifications after the alert task is completed. + [Public Preview] The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. """ warehouse_id: VariableOrOptional[str] """ - The warehouse_id identifies the warehouse settings used by the alert task. + [Public Preview] The warehouse_id identifies the warehouse settings used by the alert task. """ workspace_path: VariableOrOptional[str] """ - The workspace_path is the path to the alert file in the workspace. The path: + [Public Preview] The workspace_path is the path to the alert file in the workspace. The path: * must start with "/Workspace" * must be a normalized path. User has to select only one of alert_id or workspace_path to identify the alert. diff --git a/python/databricks/bundles/jobs/_models/alert_task_subscriber.py b/python/databricks/bundles/jobs/_models/alert_task_subscriber.py index a66936f9b40..0921eb11524 100644 --- a/python/databricks/bundles/jobs/_models/alert_task_subscriber.py +++ b/python/databricks/bundles/jobs/_models/alert_task_subscriber.py @@ -17,10 +17,13 @@ class AlertTaskSubscriber: """ destination_id: VariableOrOptional[str] = None + """ + [Public Preview] + """ user_name: VariableOrOptional[str] = None """ - A valid workspace email address. + [Public Preview] A valid workspace email address. """ @classmethod @@ -35,10 +38,13 @@ class AlertTaskSubscriberDict(TypedDict, total=False): """""" destination_id: VariableOrOptional[str] + """ + [Public Preview] + """ user_name: VariableOrOptional[str] """ - A valid workspace email address. + [Public Preview] A valid workspace email address. """ diff --git a/python/databricks/bundles/jobs/_models/compute.py b/python/databricks/bundles/jobs/_models/compute.py index d5803f81302..3df3b13d7fc 100644 --- a/python/databricks/bundles/jobs/_models/compute.py +++ b/python/databricks/bundles/jobs/_models/compute.py @@ -19,7 +19,7 @@ class Compute: hardware_accelerator: VariableOrOptional[HardwareAcceleratorType] = None """ - Hardware accelerator configuration for Serverless GPU workloads. + [Beta] Hardware accelerator configuration for Serverless GPU workloads. """ @classmethod @@ -35,7 +35,7 @@ class ComputeDict(TypedDict, total=False): hardware_accelerator: VariableOrOptional[HardwareAcceleratorTypeParam] """ - Hardware accelerator configuration for Serverless GPU workloads. + [Beta] Hardware accelerator configuration for Serverless GPU workloads. """ diff --git a/python/databricks/bundles/jobs/_models/compute_config.py b/python/databricks/bundles/jobs/_models/compute_config.py index e688eb0cd34..116d91392a4 100644 --- a/python/databricks/bundles/jobs/_models/compute_config.py +++ b/python/databricks/bundles/jobs/_models/compute_config.py @@ -19,21 +19,21 @@ class ComputeConfig: """ :meta private: [EXPERIMENTAL] - Number of GPUs. + [Private Preview] Number of GPUs. """ gpu_node_pool_id: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - IDof the GPU pool to use. + [Private Preview] IDof the GPU pool to use. """ gpu_type: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - GPU type. + [Private Preview] GPU type. """ @classmethod @@ -51,21 +51,21 @@ class ComputeConfigDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Number of GPUs. + [Private Preview] Number of GPUs. """ gpu_node_pool_id: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - IDof the GPU pool to use. + [Private Preview] IDof the GPU pool to use. """ gpu_type: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - GPU type. + [Private Preview] GPU type. """ diff --git a/python/databricks/bundles/jobs/_models/dashboard_task.py b/python/databricks/bundles/jobs/_models/dashboard_task.py index 4f9cd829a1a..c38c14f83df 100644 --- a/python/databricks/bundles/jobs/_models/dashboard_task.py +++ b/python/databricks/bundles/jobs/_models/dashboard_task.py @@ -22,7 +22,7 @@ class DashboardTask: """ :meta private: [EXPERIMENTAL] - 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. + [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. The parameter value format is dependent on the filter type: - For text and single-select filters, provide a single value (e.g. `"value"`) - For date and datetime filters, provide the value in ISO 8601 format (e.g. `"2000-01-01T00:00:00"`) @@ -55,7 +55,7 @@ class DashboardTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - 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. + [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. The parameter value format is dependent on the filter type: - For text and single-select filters, provide a single value (e.g. `"value"`) - For date and datetime filters, provide the value in ISO 8601 format (e.g. `"2000-01-01T00:00:00"`) diff --git a/python/databricks/bundles/jobs/_models/dbt_platform_task.py b/python/databricks/bundles/jobs/_models/dbt_platform_task.py index 82ebe71e220..992b8e9e922 100644 --- a/python/databricks/bundles/jobs/_models/dbt_platform_task.py +++ b/python/databricks/bundles/jobs/_models/dbt_platform_task.py @@ -19,14 +19,14 @@ class DbtPlatformTask: """ :meta private: [EXPERIMENTAL] - The resource name of the UC connection that authenticates the dbt platform for this task + [Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task """ dbt_platform_job_id: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. + [Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. """ @classmethod @@ -44,14 +44,14 @@ class DbtPlatformTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The resource name of the UC connection that authenticates the dbt platform for this task + [Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task """ dbt_platform_job_id: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. + [Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients. """ diff --git a/python/databricks/bundles/jobs/_models/environment.py b/python/databricks/bundles/jobs/_models/environment.py index 4324405f024..98b8e209434 100644 --- a/python/databricks/bundles/jobs/_models/environment.py +++ b/python/databricks/bundles/jobs/_models/environment.py @@ -47,6 +47,9 @@ class Environment: """ java_dependencies: VariableOrList[str] = field(default_factory=list) + """ + [Public Preview] + """ @classmethod def from_dict(cls, value: "EnvironmentDict") -> "Self": @@ -90,6 +93,9 @@ class EnvironmentDict(TypedDict, total=False): """ java_dependencies: VariableOrList[str] + """ + [Public Preview] + """ EnvironmentParam = EnvironmentDict | Environment diff --git a/python/databricks/bundles/jobs/_models/gcp_attributes.py b/python/databricks/bundles/jobs/_models/gcp_attributes.py index 0ab838fe214..e87ff1ab37c 100644 --- a/python/databricks/bundles/jobs/_models/gcp_attributes.py +++ b/python/databricks/bundles/jobs/_models/gcp_attributes.py @@ -34,7 +34,7 @@ class GcpAttributes: """ :meta private: [EXPERIMENTAL] - The confidential computing technology for this cluster's instances. + [Private Preview] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ @@ -105,7 +105,7 @@ class GcpAttributesDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The confidential computing technology for this cluster's instances. + [Private Preview] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ diff --git a/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py b/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py index 9bc82df2e20..d4d22f2f271 100644 --- a/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py +++ b/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py @@ -24,26 +24,28 @@ class GenAiComputeTask: """ :meta private: [EXPERIMENTAL] - Runtime image + [Private Preview] Runtime image """ command: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Command launcher to run the actual script, e.g. bash, python etc. + [Private Preview] Command launcher to run the actual script, e.g. bash, python etc. """ compute: VariableOrOptional[ComputeConfig] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ mlflow_experiment_name: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Optional string containing the name of the MLflow experiment to log the run to. If name is not + [Private Preview] 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. """ @@ -51,7 +53,7 @@ class GenAiComputeTask: """ :meta private: [EXPERIMENTAL] - 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 + [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 defined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise. * `WORKSPACE`: Script is located in Databricks workspace. * `GIT`: Script is located in cloud Git provider. @@ -61,14 +63,14 @@ class GenAiComputeTask: """ :meta private: [EXPERIMENTAL] - 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. + [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. """ yaml_parameters: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Optional string containing model parameters passed to the training script in yaml format. + [Private Preview] 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. """ @@ -76,7 +78,7 @@ class GenAiComputeTask: """ :meta private: [EXPERIMENTAL] - Optional path to a YAML file containing model parameters passed to the training script. + [Private Preview] Optional path to a YAML file containing model parameters passed to the training script. """ @classmethod @@ -94,26 +96,28 @@ class GenAiComputeTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Runtime image + [Private Preview] Runtime image """ command: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Command launcher to run the actual script, e.g. bash, python etc. + [Private Preview] Command launcher to run the actual script, e.g. bash, python etc. """ compute: VariableOrOptional[ComputeConfigParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ mlflow_experiment_name: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Optional string containing the name of the MLflow experiment to log the run to. If name is not + [Private Preview] 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. """ @@ -121,7 +125,7 @@ class GenAiComputeTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - 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 + [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 defined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise. * `WORKSPACE`: Script is located in Databricks workspace. * `GIT`: Script is located in cloud Git provider. @@ -131,14 +135,14 @@ class GenAiComputeTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - 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. + [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. """ yaml_parameters: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Optional string containing model parameters passed to the training script in yaml format. + [Private Preview] 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. """ @@ -146,7 +150,7 @@ class GenAiComputeTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Optional path to a YAML file containing model parameters passed to the training script. + [Private Preview] Optional path to a YAML file containing model parameters passed to the training script. """ diff --git a/python/databricks/bundles/jobs/_models/job.py b/python/databricks/bundles/jobs/_models/job.py index e836d4c9a89..d75cd7b1200 100644 --- a/python/databricks/bundles/jobs/_models/job.py +++ b/python/databricks/bundles/jobs/_models/job.py @@ -73,7 +73,7 @@ class Job(Resource): budget_policy_id: VariableOrOptional[str] = None """ - The id of the user specified budget policy to use for this job. + [Public Preview] The id of the user specified budget policy to use for this job. If not specified, a default budget policy may be applied when creating or modifying the job. See `effective_budget_policy_id` for the budget policy used by this workload. """ @@ -195,7 +195,7 @@ class Job(Resource): """ :meta private: [EXPERIMENTAL] - The id of the user specified usage policy to use for this job. + [Private Preview] The id of the user specified usage policy to use for this job. If not specified, a default usage policy may be applied when creating or modifying the job. See `effective_usage_policy_id` for the usage policy used by this workload. """ @@ -218,7 +218,7 @@ class JobDict(TypedDict, total=False): budget_policy_id: VariableOrOptional[str] """ - The id of the user specified budget policy to use for this job. + [Public Preview] The id of the user specified budget policy to use for this job. If not specified, a default budget policy may be applied when creating or modifying the job. See `effective_budget_policy_id` for the budget policy used by this workload. """ @@ -340,7 +340,7 @@ class JobDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The id of the user specified usage policy to use for this job. + [Private Preview] The id of the user specified usage policy to use for this job. If not specified, a default usage policy may be applied when creating or modifying the job. See `effective_usage_policy_id` for the usage policy used by this workload. """ diff --git a/python/databricks/bundles/jobs/_models/job_email_notifications.py b/python/databricks/bundles/jobs/_models/job_email_notifications.py index b97648f4dce..e8474261a8d 100644 --- a/python/databricks/bundles/jobs/_models/job_email_notifications.py +++ b/python/databricks/bundles/jobs/_models/job_email_notifications.py @@ -38,7 +38,7 @@ class JobEmailNotifications: on_streaming_backlog_exceeded: VariableOrList[str] = field(default_factory=list) """ - A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. """ @@ -82,7 +82,7 @@ class JobEmailNotificationsDict(TypedDict, total=False): on_streaming_backlog_exceeded: VariableOrList[str] """ - A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. """ diff --git a/python/databricks/bundles/jobs/_models/job_run_as.py b/python/databricks/bundles/jobs/_models/job_run_as.py index ac980cfc75b..4e5c4a72e26 100644 --- a/python/databricks/bundles/jobs/_models/job_run_as.py +++ b/python/databricks/bundles/jobs/_models/job_run_as.py @@ -21,7 +21,7 @@ class JobRunAs: """ :meta private: [EXPERIMENTAL] - Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. + [Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. """ service_principal_name: VariableOrOptional[str] = None @@ -49,7 +49,7 @@ class JobRunAsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. + [Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group. """ service_principal_name: VariableOrOptional[str] diff --git a/python/databricks/bundles/jobs/_models/model_trigger_configuration.py b/python/databricks/bundles/jobs/_models/model_trigger_configuration.py index a253b8d7dba..eebf5713a93 100644 --- a/python/databricks/bundles/jobs/_models/model_trigger_configuration.py +++ b/python/databricks/bundles/jobs/_models/model_trigger_configuration.py @@ -27,21 +27,21 @@ class ModelTriggerConfiguration: """ :meta private: [EXPERIMENTAL] - The condition based on which to trigger a job run. + [Private Preview] The condition based on which to trigger a job run. """ aliases: VariableOrList[str] = field(default_factory=list) """ :meta private: [EXPERIMENTAL] - Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. + [Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. """ min_time_between_triggers_seconds: VariableOrOptional[int] = None """ :meta private: [EXPERIMENTAL] - If set, the trigger starts a run only after the specified amount of time has passed since + [Private Preview] 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. """ @@ -49,7 +49,7 @@ class ModelTriggerConfiguration: """ :meta private: [EXPERIMENTAL] - Name of the securable to monitor ("mycatalog.myschema.mymodel" in the case of model-level triggers, + [Private Preview] 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. """ @@ -57,7 +57,7 @@ class ModelTriggerConfiguration: """ :meta private: [EXPERIMENTAL] - If set, the trigger starts a run only after no model updates have occurred for the specified time + [Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time and can be used to wait for a series of model updates before triggering a run. The minimum allowed value is 60 seconds. """ @@ -77,21 +77,21 @@ class ModelTriggerConfigurationDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The condition based on which to trigger a job run. + [Private Preview] The condition based on which to trigger a job run. """ aliases: VariableOrList[str] """ :meta private: [EXPERIMENTAL] - Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. + [Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET. """ min_time_between_triggers_seconds: VariableOrOptional[int] """ :meta private: [EXPERIMENTAL] - If set, the trigger starts a run only after the specified amount of time has passed since + [Private Preview] 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. """ @@ -99,7 +99,7 @@ class ModelTriggerConfigurationDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Name of the securable to monitor ("mycatalog.myschema.mymodel" in the case of model-level triggers, + [Private Preview] 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. """ @@ -107,7 +107,7 @@ class ModelTriggerConfigurationDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - If set, the trigger starts a run only after no model updates have occurred for the specified time + [Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time and can be used to wait for a series of model updates before triggering a run. The minimum allowed value is 60 seconds. """ diff --git a/python/databricks/bundles/jobs/_models/pipeline_params.py b/python/databricks/bundles/jobs/_models/pipeline_params.py index 488018cb3d8..6c653b3e6c3 100644 --- a/python/databricks/bundles/jobs/_models/pipeline_params.py +++ b/python/databricks/bundles/jobs/_models/pipeline_params.py @@ -20,23 +20,23 @@ class PipelineParams: full_refresh_selection: VariableOrList[str] = field(default_factory=list) """ - A list of tables to update with fullRefresh. + [Beta] A list of tables to update with fullRefresh. """ refresh_flow_selection: VariableOrList[str] = field(default_factory=list) """ - Flow names to selectively refresh. These are unioned with other selective refresh + [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. """ refresh_selection: VariableOrList[str] = field(default_factory=list) """ - A list of tables to update without fullRefresh. + [Beta] A list of tables to update without fullRefresh. """ reset_checkpoint_selection: VariableOrList[str] = field(default_factory=list) """ - A list of streaming flows to reset checkpoints without clearing data. + [Beta] A list of streaming flows to reset checkpoints without clearing data. """ @classmethod @@ -57,23 +57,23 @@ class PipelineParamsDict(TypedDict, total=False): full_refresh_selection: VariableOrList[str] """ - A list of tables to update with fullRefresh. + [Beta] A list of tables to update with fullRefresh. """ refresh_flow_selection: VariableOrList[str] """ - Flow names to selectively refresh. These are unioned with other selective refresh + [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. """ refresh_selection: VariableOrList[str] """ - A list of tables to update without fullRefresh. + [Beta] A list of tables to update without fullRefresh. """ reset_checkpoint_selection: VariableOrList[str] """ - A list of streaming flows to reset checkpoints without clearing data. + [Beta] A list of streaming flows to reset checkpoints without clearing data. """ diff --git a/python/databricks/bundles/jobs/_models/pipeline_task.py b/python/databricks/bundles/jobs/_models/pipeline_task.py index 5489156892b..256a5d8f913 100644 --- a/python/databricks/bundles/jobs/_models/pipeline_task.py +++ b/python/databricks/bundles/jobs/_models/pipeline_task.py @@ -30,29 +30,29 @@ class PipelineTask: full_refresh_selection: VariableOrList[str] = field(default_factory=list) """ - A list of tables to update with fullRefresh. + [Beta] A list of tables to update with fullRefresh. """ parameters: VariableOrDict[str] = field(default_factory=dict) """ - Key/value-map of parameters passed to the pipeline execution. + [Beta] Key/value-map of parameters passed to the pipeline execution. Limited to 10k characters in total. """ refresh_flow_selection: VariableOrList[str] = field(default_factory=list) """ - Flow names to selectively refresh. These are unioned with other selective refresh + [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. """ refresh_selection: VariableOrList[str] = field(default_factory=list) """ - A list of tables to update without fullRefresh. + [Beta] A list of tables to update without fullRefresh. """ reset_checkpoint_selection: VariableOrList[str] = field(default_factory=list) """ - A list of streaming flows to reset checkpoints without clearing data. + [Beta] A list of streaming flows to reset checkpoints without clearing data. """ @classmethod @@ -78,29 +78,29 @@ class PipelineTaskDict(TypedDict, total=False): full_refresh_selection: VariableOrList[str] """ - A list of tables to update with fullRefresh. + [Beta] A list of tables to update with fullRefresh. """ parameters: VariableOrDict[str] """ - Key/value-map of parameters passed to the pipeline execution. + [Beta] Key/value-map of parameters passed to the pipeline execution. Limited to 10k characters in total. """ refresh_flow_selection: VariableOrList[str] """ - Flow names to selectively refresh. These are unioned with other selective refresh + [Beta] Flow names to selectively refresh. These are unioned with other selective refresh options (refresh_selection, full_refresh_selection) to determine the final set of flows to refresh. """ refresh_selection: VariableOrList[str] """ - A list of tables to update without fullRefresh. + [Beta] A list of tables to update without fullRefresh. """ reset_checkpoint_selection: VariableOrList[str] """ - A list of streaming flows to reset checkpoints without clearing data. + [Beta] A list of streaming flows to reset checkpoints without clearing data. """ diff --git a/python/databricks/bundles/jobs/_models/power_bi_model.py b/python/databricks/bundles/jobs/_models/power_bi_model.py index b31c5735abb..72ddd53ea21 100644 --- a/python/databricks/bundles/jobs/_models/power_bi_model.py +++ b/python/databricks/bundles/jobs/_models/power_bi_model.py @@ -20,27 +20,27 @@ class PowerBiModel: authentication_method: VariableOrOptional[AuthenticationMethod] = None """ - How the published Power BI model authenticates to Databricks + [Public Preview] How the published Power BI model authenticates to Databricks """ model_name: VariableOrOptional[str] = None """ - The name of the Power BI model + [Public Preview] The name of the Power BI model """ overwrite_existing: VariableOrOptional[bool] = None """ - Whether to overwrite existing Power BI models + [Public Preview] Whether to overwrite existing Power BI models """ storage_mode: VariableOrOptional[StorageMode] = None """ - The default storage mode of the Power BI model + [Public Preview] The default storage mode of the Power BI model """ workspace_name: VariableOrOptional[str] = None """ - The name of the Power BI workspace of the model + [Public Preview] The name of the Power BI workspace of the model """ @classmethod @@ -56,27 +56,27 @@ class PowerBiModelDict(TypedDict, total=False): authentication_method: VariableOrOptional[AuthenticationMethodParam] """ - How the published Power BI model authenticates to Databricks + [Public Preview] How the published Power BI model authenticates to Databricks """ model_name: VariableOrOptional[str] """ - The name of the Power BI model + [Public Preview] The name of the Power BI model """ overwrite_existing: VariableOrOptional[bool] """ - Whether to overwrite existing Power BI models + [Public Preview] Whether to overwrite existing Power BI models """ storage_mode: VariableOrOptional[StorageModeParam] """ - The default storage mode of the Power BI model + [Public Preview] The default storage mode of the Power BI model """ workspace_name: VariableOrOptional[str] """ - The name of the Power BI workspace of the model + [Public Preview] The name of the Power BI workspace of the model """ diff --git a/python/databricks/bundles/jobs/_models/power_bi_table.py b/python/databricks/bundles/jobs/_models/power_bi_table.py index 83e433da6d8..4c91b194cf5 100644 --- a/python/databricks/bundles/jobs/_models/power_bi_table.py +++ b/python/databricks/bundles/jobs/_models/power_bi_table.py @@ -16,22 +16,22 @@ class PowerBiTable: catalog: VariableOrOptional[str] = None """ - The catalog name in Databricks + [Public Preview] The catalog name in Databricks """ name: VariableOrOptional[str] = None """ - The table name in Databricks + [Public Preview] The table name in Databricks """ schema: VariableOrOptional[str] = None """ - The schema name in Databricks + [Public Preview] The schema name in Databricks """ storage_mode: VariableOrOptional[StorageMode] = None """ - The Power BI storage mode of the table + [Public Preview] The Power BI storage mode of the table """ @classmethod @@ -47,22 +47,22 @@ class PowerBiTableDict(TypedDict, total=False): catalog: VariableOrOptional[str] """ - The catalog name in Databricks + [Public Preview] The catalog name in Databricks """ name: VariableOrOptional[str] """ - The table name in Databricks + [Public Preview] The table name in Databricks """ schema: VariableOrOptional[str] """ - The schema name in Databricks + [Public Preview] The schema name in Databricks """ storage_mode: VariableOrOptional[StorageModeParam] """ - The Power BI storage mode of the table + [Public Preview] The Power BI storage mode of the table """ diff --git a/python/databricks/bundles/jobs/_models/power_bi_task.py b/python/databricks/bundles/jobs/_models/power_bi_task.py index ceea220ed89..61d6930d1bf 100644 --- a/python/databricks/bundles/jobs/_models/power_bi_task.py +++ b/python/databricks/bundles/jobs/_models/power_bi_task.py @@ -23,27 +23,27 @@ class PowerBiTask: connection_resource_name: VariableOrOptional[str] = None """ - The resource name of the UC connection to authenticate from Databricks to Power BI + [Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI """ power_bi_model: VariableOrOptional[PowerBiModel] = None """ - The semantic model to update + [Public Preview] The semantic model to update """ refresh_after_update: VariableOrOptional[bool] = None """ - Whether the model should be refreshed after the update + [Public Preview] Whether the model should be refreshed after the update """ tables: VariableOrList[PowerBiTable] = field(default_factory=list) """ - The tables to be exported to Power BI + [Public Preview] The tables to be exported to Power BI """ warehouse_id: VariableOrOptional[str] = None """ - The SQL warehouse ID to use as the Power BI data source + [Public Preview] The SQL warehouse ID to use as the Power BI data source """ @classmethod @@ -59,27 +59,27 @@ class PowerBiTaskDict(TypedDict, total=False): connection_resource_name: VariableOrOptional[str] """ - The resource name of the UC connection to authenticate from Databricks to Power BI + [Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI """ power_bi_model: VariableOrOptional[PowerBiModelParam] """ - The semantic model to update + [Public Preview] The semantic model to update """ refresh_after_update: VariableOrOptional[bool] """ - Whether the model should be refreshed after the update + [Public Preview] Whether the model should be refreshed after the update """ tables: VariableOrList[PowerBiTableParam] """ - The tables to be exported to Power BI + [Public Preview] The tables to be exported to Power BI """ warehouse_id: VariableOrOptional[str] """ - The SQL warehouse ID to use as the Power BI data source + [Public Preview] The SQL warehouse ID to use as the Power BI data source """ diff --git a/python/databricks/bundles/jobs/_models/python_operator_task.py b/python/databricks/bundles/jobs/_models/python_operator_task.py index cf6f4760ba3..be557e49e63 100644 --- a/python/databricks/bundles/jobs/_models/python_operator_task.py +++ b/python/databricks/bundles/jobs/_models/python_operator_task.py @@ -23,7 +23,7 @@ class PythonOperatorTask: """ :meta private: [EXPERIMENTAL] - Fully qualified name of the main class or function. + [Private Preview] Fully qualified name of the main class or function. For example, `my_project.my_function` or `my_project.MyOperator`. """ @@ -33,7 +33,7 @@ class PythonOperatorTask: """ :meta private: [EXPERIMENTAL] - An ordered list of task parameters. + [Private Preview] An ordered list of task parameters. TODO(JOBS-30885): Add limits for parameters. """ @@ -52,7 +52,7 @@ class PythonOperatorTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Fully qualified name of the main class or function. + [Private Preview] Fully qualified name of the main class or function. For example, `my_project.my_function` or `my_project.MyOperator`. """ @@ -60,7 +60,7 @@ class PythonOperatorTaskDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - An ordered list of task parameters. + [Private Preview] An ordered list of task parameters. TODO(JOBS-30885): Add limits for parameters. """ diff --git a/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py b/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py index b1f252b3106..e109668e4e2 100644 --- a/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py +++ b/python/databricks/bundles/jobs/_models/python_operator_task_parameter.py @@ -18,11 +18,15 @@ class PythonOperatorTaskParameter: name: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ value: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -39,11 +43,15 @@ class PythonOperatorTaskParameterDict(TypedDict, total=False): name: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ value: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/jobs/_models/task.py b/python/databricks/bundles/jobs/_models/task.py index 8cb2fe0c273..19f12c8a993 100644 --- a/python/databricks/bundles/jobs/_models/task.py +++ b/python/databricks/bundles/jobs/_models/task.py @@ -110,7 +110,7 @@ class Task: alert_task: VariableOrOptional[AlertTask] = None """ - The task evaluates a Databricks alert and sends notifications to subscribers + [Public Preview] The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. """ @@ -122,7 +122,7 @@ class Task: compute: VariableOrOptional[Compute] = None """ - Task level compute configuration. + [Beta] Task level compute configuration. """ condition_task: VariableOrOptional[ConditionTask] = None @@ -139,6 +139,8 @@ class Task: dbt_platform_task: VariableOrOptional[DbtPlatformTask] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ dbt_task: VariableOrOptional[DbtTask] = None @@ -193,6 +195,8 @@ class Task: gen_ai_compute_task: VariableOrOptional[GenAiComputeTask] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ health: VariableOrOptional[JobsHealthRules] = None @@ -240,14 +244,14 @@ class Task: power_bi_task: VariableOrOptional[PowerBiTask] = None """ - The task triggers a Power BI semantic model update when the `power_bi_task` field is present. + [Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present. """ python_operator_task: VariableOrOptional[PythonOperatorTask] = None """ :meta private: [EXPERIMENTAL] - The task runs a Python operator task. + [Private Preview] The task runs a Python operator task. """ python_wheel_task: VariableOrOptional[PythonWheelTask] = None @@ -328,7 +332,7 @@ class TaskDict(TypedDict, total=False): alert_task: VariableOrOptional[AlertTaskParam] """ - The task evaluates a Databricks alert and sends notifications to subscribers + [Public Preview] The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. """ @@ -340,7 +344,7 @@ class TaskDict(TypedDict, total=False): compute: VariableOrOptional[ComputeParam] """ - Task level compute configuration. + [Beta] Task level compute configuration. """ condition_task: VariableOrOptional[ConditionTaskParam] @@ -357,6 +361,8 @@ class TaskDict(TypedDict, total=False): dbt_platform_task: VariableOrOptional[DbtPlatformTaskParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ dbt_task: VariableOrOptional[DbtTaskParam] @@ -411,6 +417,8 @@ class TaskDict(TypedDict, total=False): gen_ai_compute_task: VariableOrOptional[GenAiComputeTaskParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ health: VariableOrOptional[JobsHealthRulesParam] @@ -458,14 +466,14 @@ class TaskDict(TypedDict, total=False): power_bi_task: VariableOrOptional[PowerBiTaskParam] """ - The task triggers a Power BI semantic model update when the `power_bi_task` field is present. + [Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present. """ python_operator_task: VariableOrOptional[PythonOperatorTaskParam] """ :meta private: [EXPERIMENTAL] - The task runs a Python operator task. + [Private Preview] The task runs a Python operator task. """ python_wheel_task: VariableOrOptional[PythonWheelTaskParam] diff --git a/python/databricks/bundles/jobs/_models/task_email_notifications.py b/python/databricks/bundles/jobs/_models/task_email_notifications.py index 35837985156..5b0ae515f61 100644 --- a/python/databricks/bundles/jobs/_models/task_email_notifications.py +++ b/python/databricks/bundles/jobs/_models/task_email_notifications.py @@ -38,7 +38,7 @@ class TaskEmailNotifications: on_streaming_backlog_exceeded: VariableOrList[str] = field(default_factory=list) """ - A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. """ @@ -82,7 +82,7 @@ class TaskEmailNotificationsDict(TypedDict, total=False): on_streaming_backlog_exceeded: VariableOrList[str] """ - A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. """ diff --git a/python/databricks/bundles/jobs/_models/trigger_settings.py b/python/databricks/bundles/jobs/_models/trigger_settings.py index 67b3a4def74..490f5175dd8 100644 --- a/python/databricks/bundles/jobs/_models/trigger_settings.py +++ b/python/databricks/bundles/jobs/_models/trigger_settings.py @@ -38,6 +38,8 @@ class TriggerSettings: model: VariableOrOptional[ModelTriggerConfiguration] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ pause_status: VariableOrOptional[PauseStatus] = None @@ -71,6 +73,8 @@ class TriggerSettingsDict(TypedDict, total=False): model: VariableOrOptional[ModelTriggerConfigurationParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ pause_status: VariableOrOptional[PauseStatusParam] diff --git a/python/databricks/bundles/jobs/_models/webhook_notifications.py b/python/databricks/bundles/jobs/_models/webhook_notifications.py index c0f3edf0887..ffd043261dc 100644 --- a/python/databricks/bundles/jobs/_models/webhook_notifications.py +++ b/python/databricks/bundles/jobs/_models/webhook_notifications.py @@ -33,7 +33,7 @@ class WebhookNotifications: on_streaming_backlog_exceeded: VariableOrList[Webhook] = field(default_factory=list) """ - An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. A maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property. @@ -72,7 +72,7 @@ class WebhookNotificationsDict(TypedDict, total=False): on_streaming_backlog_exceeded: VariableOrList[WebhookParam] """ - An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream. + [Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. A maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property. diff --git a/python/databricks/bundles/pipelines/_models/auto_full_refresh_policy.py b/python/databricks/bundles/pipelines/_models/auto_full_refresh_policy.py index e8b5b69de33..3a538d30fa6 100644 --- a/python/databricks/bundles/pipelines/_models/auto_full_refresh_policy.py +++ b/python/databricks/bundles/pipelines/_models/auto_full_refresh_policy.py @@ -17,12 +17,12 @@ class AutoFullRefreshPolicy: enabled: VariableOr[bool] """ - (Required, Mutable) Whether to enable auto full refresh or not. + [Public Preview] (Required, Mutable) Whether to enable auto full refresh or not. """ min_interval_hours: VariableOrOptional[int] = None """ - (Optional, Mutable) Specify the minimum interval in hours between the timestamp + [Public Preview] (Optional, Mutable) Specify the minimum interval in hours between the timestamp at which a table was last full refreshed and the current timestamp for triggering auto full If unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours. """ @@ -40,12 +40,12 @@ class AutoFullRefreshPolicyDict(TypedDict, total=False): enabled: VariableOr[bool] """ - (Required, Mutable) Whether to enable auto full refresh or not. + [Public Preview] (Required, Mutable) Whether to enable auto full refresh or not. """ min_interval_hours: VariableOrOptional[int] """ - (Optional, Mutable) Specify the minimum interval in hours between the timestamp + [Public Preview] (Optional, Mutable) Specify the minimum interval in hours between the timestamp at which a table was last full refreshed and the current timestamp for triggering auto full If unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours. """ diff --git a/python/databricks/bundles/pipelines/_models/confluence_connector_options.py b/python/databricks/bundles/pipelines/_models/confluence_connector_options.py index 8158448f323..0c6ed1f1ebe 100644 --- a/python/databricks/bundles/pipelines/_models/confluence_connector_options.py +++ b/python/databricks/bundles/pipelines/_models/confluence_connector_options.py @@ -17,7 +17,7 @@ class ConfluenceConnectorOptions: include_confluence_spaces: VariableOrList[str] = field(default_factory=list) """ - (Optional) Spaces to filter Confluence data on + [Public Preview] (Optional) Spaces to filter Confluence data on """ @classmethod @@ -33,7 +33,7 @@ class ConfluenceConnectorOptionsDict(TypedDict, total=False): include_confluence_spaces: VariableOrList[str] """ - (Optional) Spaces to filter Confluence data on + [Public Preview] (Optional) Spaces to filter Confluence data on """ diff --git a/python/databricks/bundles/pipelines/_models/connection_parameters.py b/python/databricks/bundles/pipelines/_models/connection_parameters.py index 98ed0dbcda0..e4c3d43cc59 100644 --- a/python/databricks/bundles/pipelines/_models/connection_parameters.py +++ b/python/databricks/bundles/pipelines/_models/connection_parameters.py @@ -19,7 +19,7 @@ class ConnectionParameters: """ :meta private: [EXPERIMENTAL] - Source catalog for initial connection. + [Private Preview] Source catalog for initial connection. This is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have in some other database systems like Postgres. For Oracle databases, this maps to a service name. @@ -40,7 +40,7 @@ class ConnectionParametersDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Source catalog for initial connection. + [Private Preview] Source catalog for initial connection. This is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have in some other database systems like Postgres. For Oracle databases, this maps to a service name. diff --git a/python/databricks/bundles/pipelines/_models/connector_options.py b/python/databricks/bundles/pipelines/_models/connector_options.py index b236e16f762..ba03b1619fb 100644 --- a/python/databricks/bundles/pipelines/_models/connector_options.py +++ b/python/databricks/bundles/pipelines/_models/connector_options.py @@ -61,69 +61,75 @@ class ConnectorOptions: confluence_options: VariableOrOptional[ConfluenceConnectorOptions] = None """ - Confluence specific options for ingestion + [Public Preview] Confluence specific options for ingestion """ gdrive_options: VariableOrOptional[GoogleDriveOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ google_ads_options: VariableOrOptional[GoogleAdsOptions] = None """ :meta private: [EXPERIMENTAL] - Google Ads specific options for ingestion (object-level). + [Private Preview] Google Ads specific options for ingestion (object-level). When set, these values override the corresponding fields in GoogleAdsConfig (source_configurations). """ jira_options: VariableOrOptional[JiraConnectorOptions] = None """ - Jira specific options for ingestion + [Beta] Jira specific options for ingestion """ kafka_options: VariableOrOptional[KafkaOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ meta_ads_options: VariableOrOptional[MetaMarketingOptions] = None """ - Meta Marketing (Meta Ads) specific options for ingestion + [Beta] Meta Marketing (Meta Ads) specific options for ingestion """ outlook_options: VariableOrOptional[OutlookOptions] = None """ :meta private: [EXPERIMENTAL] - Outlook specific options for ingestion + [Private Preview] Outlook specific options for ingestion """ sharepoint_options: VariableOrOptional[SharepointOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ smartsheet_options: VariableOrOptional[SmartsheetOptions] = None """ :meta private: [EXPERIMENTAL] - Smartsheet specific options for ingestion + [Private Preview] Smartsheet specific options for ingestion """ tiktok_ads_options: VariableOrOptional[TikTokAdsOptions] = None """ :meta private: [EXPERIMENTAL] - TikTok Ads specific options for ingestion + [Private Preview] TikTok Ads specific options for ingestion """ zendesk_support_options: VariableOrOptional[ZendeskSupportOptions] = None """ :meta private: [EXPERIMENTAL] - Zendesk Support specific options for ingestion + [Private Preview] Zendesk Support specific options for ingestion """ @classmethod @@ -139,69 +145,75 @@ class ConnectorOptionsDict(TypedDict, total=False): confluence_options: VariableOrOptional[ConfluenceConnectorOptionsParam] """ - Confluence specific options for ingestion + [Public Preview] Confluence specific options for ingestion """ gdrive_options: VariableOrOptional[GoogleDriveOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ google_ads_options: VariableOrOptional[GoogleAdsOptionsParam] """ :meta private: [EXPERIMENTAL] - Google Ads specific options for ingestion (object-level). + [Private Preview] Google Ads specific options for ingestion (object-level). When set, these values override the corresponding fields in GoogleAdsConfig (source_configurations). """ jira_options: VariableOrOptional[JiraConnectorOptionsParam] """ - Jira specific options for ingestion + [Beta] Jira specific options for ingestion """ kafka_options: VariableOrOptional[KafkaOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ meta_ads_options: VariableOrOptional[MetaMarketingOptionsParam] """ - Meta Marketing (Meta Ads) specific options for ingestion + [Beta] Meta Marketing (Meta Ads) specific options for ingestion """ outlook_options: VariableOrOptional[OutlookOptionsParam] """ :meta private: [EXPERIMENTAL] - Outlook specific options for ingestion + [Private Preview] Outlook specific options for ingestion """ sharepoint_options: VariableOrOptional[SharepointOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ smartsheet_options: VariableOrOptional[SmartsheetOptionsParam] """ :meta private: [EXPERIMENTAL] - Smartsheet specific options for ingestion + [Private Preview] Smartsheet specific options for ingestion """ tiktok_ads_options: VariableOrOptional[TikTokAdsOptionsParam] """ :meta private: [EXPERIMENTAL] - TikTok Ads specific options for ingestion + [Private Preview] TikTok Ads specific options for ingestion """ zendesk_support_options: VariableOrOptional[ZendeskSupportOptionsParam] """ :meta private: [EXPERIMENTAL] - Zendesk Support specific options for ingestion + [Private Preview] Zendesk Support specific options for ingestion """ diff --git a/python/databricks/bundles/pipelines/_models/data_staging_options.py b/python/databricks/bundles/pipelines/_models/data_staging_options.py index 3b6854b81dd..c6e599c73fb 100644 --- a/python/databricks/bundles/pipelines/_models/data_staging_options.py +++ b/python/databricks/bundles/pipelines/_models/data_staging_options.py @@ -17,17 +17,17 @@ class DataStagingOptions: catalog_name: VariableOr[str] """ - (Required, Immutable) The name of the catalog for the connector's staging storage location. + [Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location. """ schema_name: VariableOr[str] """ - (Required, Immutable) The name of the schema for the connector's staging storage location. + [Beta] (Required, Immutable) The name of the schema for the connector's staging storage location. """ volume_name: VariableOrOptional[str] = None """ - (Optional) The Unity Catalog-compatible name for the storage location. + [Beta] (Optional) The Unity Catalog-compatible name for the storage location. This is the volume to use for the data that is extracted by the connector. Spark Declarative Pipelines system will automatically create the volume under the catalog and schema. For Combined Cdc Managed Ingestion pipelines default name for the volume would be : @@ -47,17 +47,17 @@ class DataStagingOptionsDict(TypedDict, total=False): catalog_name: VariableOr[str] """ - (Required, Immutable) The name of the catalog for the connector's staging storage location. + [Beta] (Required, Immutable) The name of the catalog for the connector's staging storage location. """ schema_name: VariableOr[str] """ - (Required, Immutable) The name of the schema for the connector's staging storage location. + [Beta] (Required, Immutable) The name of the schema for the connector's staging storage location. """ volume_name: VariableOrOptional[str] """ - (Optional) The Unity Catalog-compatible name for the storage location. + [Beta] (Optional) The Unity Catalog-compatible name for the storage location. This is the volume to use for the data that is extracted by the connector. Spark Declarative Pipelines system will automatically create the volume under the catalog and schema. For Combined Cdc Managed Ingestion pipelines default name for the volume would be : diff --git a/python/databricks/bundles/pipelines/_models/file_filter.py b/python/databricks/bundles/pipelines/_models/file_filter.py index 92283b649c8..8d24212250d 100644 --- a/python/databricks/bundles/pipelines/_models/file_filter.py +++ b/python/databricks/bundles/pipelines/_models/file_filter.py @@ -19,7 +19,7 @@ class FileFilter: """ :meta private: [EXPERIMENTAL] - Include files with modification times occurring after the specified time. + [Private Preview] Include files with modification times occurring after the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters """ @@ -28,7 +28,7 @@ class FileFilter: """ :meta private: [EXPERIMENTAL] - Include files with modification times occurring before the specified time. + [Private Preview] Include files with modification times occurring before the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters """ @@ -37,7 +37,7 @@ class FileFilter: """ :meta private: [EXPERIMENTAL] - Include files with file names matching the pattern + [Private Preview] 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 """ @@ -56,7 +56,7 @@ class FileFilterDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Include files with modification times occurring after the specified time. + [Private Preview] Include files with modification times occurring after the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters """ @@ -65,7 +65,7 @@ class FileFilterDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Include files with modification times occurring before the specified time. + [Private Preview] Include files with modification times occurring before the specified time. Timestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00) Based on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters """ @@ -74,7 +74,7 @@ class FileFilterDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Include files with file names matching the pattern + [Private Preview] 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 """ diff --git a/python/databricks/bundles/pipelines/_models/file_ingestion_options.py b/python/databricks/bundles/pipelines/_models/file_ingestion_options.py index 1d6f18dfc5f..c3855364f72 100644 --- a/python/databricks/bundles/pipelines/_models/file_ingestion_options.py +++ b/python/databricks/bundles/pipelines/_models/file_ingestion_options.py @@ -31,51 +31,59 @@ class FileIngestionOptions: corrupt_record_column: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ file_filters: VariableOrList[FileFilter] = field(default_factory=list) """ :meta private: [EXPERIMENTAL] - Generic options + [Private Preview] Generic options """ format: VariableOrOptional[FileIngestionOptionsFileFormat] = None """ :meta private: [EXPERIMENTAL] - required for TableSpec + [Private Preview] required for TableSpec """ format_options: VariableOrDict[str] = field(default_factory=dict) """ :meta private: [EXPERIMENTAL] - Format-specific options + [Private Preview] Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options """ ignore_corrupt_files: VariableOrOptional[bool] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ infer_column_types: VariableOrOptional[bool] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ reader_case_sensitive: VariableOrOptional[bool] = None """ :meta private: [EXPERIMENTAL] - Column name case sensitivity + [Private Preview] Column name case sensitivity https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior """ rescued_data_column: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ schema_evolution_mode: VariableOrOptional[ @@ -84,20 +92,22 @@ class FileIngestionOptions: """ :meta private: [EXPERIMENTAL] - Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + [Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work """ schema_hints: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Override inferred schema of specific columns + [Private Preview] 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 """ single_variant_column: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -114,51 +124,59 @@ class FileIngestionOptionsDict(TypedDict, total=False): corrupt_record_column: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ file_filters: VariableOrList[FileFilterParam] """ :meta private: [EXPERIMENTAL] - Generic options + [Private Preview] Generic options """ format: VariableOrOptional[FileIngestionOptionsFileFormatParam] """ :meta private: [EXPERIMENTAL] - required for TableSpec + [Private Preview] required for TableSpec """ format_options: VariableOrDict[str] """ :meta private: [EXPERIMENTAL] - Format-specific options + [Private Preview] Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options """ ignore_corrupt_files: VariableOrOptional[bool] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ infer_column_types: VariableOrOptional[bool] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ reader_case_sensitive: VariableOrOptional[bool] """ :meta private: [EXPERIMENTAL] - Column name case sensitivity + [Private Preview] Column name case sensitivity https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior """ rescued_data_column: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ schema_evolution_mode: VariableOrOptional[ @@ -167,20 +185,22 @@ class FileIngestionOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work + [Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work """ schema_hints: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Override inferred schema of specific columns + [Private Preview] 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 """ single_variant_column: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/pipelines/_models/gcp_attributes.py b/python/databricks/bundles/pipelines/_models/gcp_attributes.py index 1670e8c02f5..7ae9b24d4d5 100644 --- a/python/databricks/bundles/pipelines/_models/gcp_attributes.py +++ b/python/databricks/bundles/pipelines/_models/gcp_attributes.py @@ -34,7 +34,7 @@ class GcpAttributes: """ :meta private: [EXPERIMENTAL] - The confidential computing technology for this cluster's instances. + [Private Preview] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ @@ -105,7 +105,7 @@ class GcpAttributesDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The confidential computing technology for this cluster's instances. + [Private Preview] The confidential computing technology for this cluster's instances. Currently only SEV_SNP is supported, and only on N2D instance types. When not set, no confidential computing is applied. """ diff --git a/python/databricks/bundles/pipelines/_models/google_ads_config.py b/python/databricks/bundles/pipelines/_models/google_ads_config.py index debbe468b2b..68ad306a40c 100644 --- a/python/databricks/bundles/pipelines/_models/google_ads_config.py +++ b/python/databricks/bundles/pipelines/_models/google_ads_config.py @@ -19,7 +19,7 @@ class GoogleAdsConfig: """ :meta private: [EXPERIMENTAL] - (Required) Manager Account ID (also called MCC Account ID) used to list and access + [Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. This is required for fetching the list of customer accounts during source selection. If the same field is also set in the object-level GoogleAdsOptions (connector_options), @@ -41,7 +41,7 @@ class GoogleAdsConfigDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Required) Manager Account ID (also called MCC Account ID) used to list and access + [Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. This is required for fetching the list of customer accounts during source selection. If the same field is also set in the object-level GoogleAdsOptions (connector_options), diff --git a/python/databricks/bundles/pipelines/_models/google_ads_options.py b/python/databricks/bundles/pipelines/_models/google_ads_options.py index 3cd04a5ef7f..3af2893e5a5 100644 --- a/python/databricks/bundles/pipelines/_models/google_ads_options.py +++ b/python/databricks/bundles/pipelines/_models/google_ads_options.py @@ -23,7 +23,7 @@ class GoogleAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional at this level) Manager Account ID (also called MCC Account ID) used to list + [Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. Overrides GoogleAdsConfig.manager_account_id from source_configurations when set. """ @@ -32,7 +32,7 @@ class GoogleAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Number of days to look back for report tables to capture late-arriving data. + [Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data. If not specified, defaults to 30 days. """ @@ -40,7 +40,7 @@ class GoogleAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. If not specified, defaults to 2 years of historical data. """ @@ -60,7 +60,7 @@ class GoogleAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional at this level) Manager Account ID (also called MCC Account ID) used to list + [Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list and access customer accounts under this manager account. Overrides GoogleAdsConfig.manager_account_id from source_configurations when set. """ @@ -69,7 +69,7 @@ class GoogleAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Number of days to look back for report tables to capture late-arriving data. + [Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data. If not specified, defaults to 30 days. """ @@ -77,7 +77,7 @@ class GoogleAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. If not specified, defaults to 2 years of historical data. """ diff --git a/python/databricks/bundles/pipelines/_models/google_drive_options.py b/python/databricks/bundles/pipelines/_models/google_drive_options.py index 71b251e83e8..968daabefb7 100644 --- a/python/databricks/bundles/pipelines/_models/google_drive_options.py +++ b/python/databricks/bundles/pipelines/_models/google_drive_options.py @@ -26,18 +26,22 @@ class GoogleDriveOptions: entity_type: VariableOrOptional[GoogleDriveOptionsGoogleDriveEntityType] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ file_ingestion_options: VariableOrOptional[FileIngestionOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ url: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Google Drive URL. + [Private Preview] Google Drive URL. """ @classmethod @@ -54,18 +58,22 @@ class GoogleDriveOptionsDict(TypedDict, total=False): entity_type: VariableOrOptional[GoogleDriveOptionsGoogleDriveEntityTypeParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ file_ingestion_options: VariableOrOptional[FileIngestionOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ url: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Google Drive URL. + [Private Preview] Google Drive URL. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_config.py b/python/databricks/bundles/pipelines/_models/ingestion_config.py index c452222df9c..b9276540f8a 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_config.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_config.py @@ -18,17 +18,17 @@ class IngestionConfig: report: VariableOrOptional[ReportSpec] = None """ - Select a specific source report. + [Public Preview] Select a specific source report. """ schema: VariableOrOptional[SchemaSpec] = None """ - Select all tables from a specific source schema. + [Public Preview] Select all tables from a specific source schema. """ table: VariableOrOptional[TableSpec] = None """ - Select a specific source table. + [Public Preview] Select a specific source table. """ @classmethod @@ -44,17 +44,17 @@ class IngestionConfigDict(TypedDict, total=False): report: VariableOrOptional[ReportSpecParam] """ - Select a specific source report. + [Public Preview] Select a specific source report. """ schema: VariableOrOptional[SchemaSpecParam] """ - Select all tables from a specific source schema. + [Public Preview] Select all tables from a specific source schema. """ table: VariableOrOptional[TableSpecParam] """ - Select a specific source table. + [Public Preview] Select a specific source table. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py b/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py index 79c26080742..a1f73e0a85c 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py @@ -23,35 +23,35 @@ class IngestionGatewayPipelineDefinition: """ :meta private: [EXPERIMENTAL] - Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + [Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. """ gateway_storage_catalog: VariableOr[str] """ :meta private: [EXPERIMENTAL] - Required, Immutable. The name of the catalog for the gateway pipeline's storage location. + [Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location. """ gateway_storage_schema: VariableOr[str] """ :meta private: [EXPERIMENTAL] - Required, Immutable. The name of the schema for the gateway pipelines's storage location. + [Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location. """ connection_parameters: VariableOrOptional[ConnectionParameters] = None """ :meta private: [EXPERIMENTAL] - Optional, Internal. Parameters required to establish an initial connection with the source. + [Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source. """ gateway_storage_name: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Optional. The Unity Catalog-compatible name for the gateway storage location. + [Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location. This is the destination to use for the data that is extracted by the gateway. Spark Declarative Pipelines system will automatically create the storage location under the catalog and schema. """ @@ -71,35 +71,35 @@ class IngestionGatewayPipelineDefinitionDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + [Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. """ gateway_storage_catalog: VariableOr[str] """ :meta private: [EXPERIMENTAL] - Required, Immutable. The name of the catalog for the gateway pipeline's storage location. + [Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location. """ gateway_storage_schema: VariableOr[str] """ :meta private: [EXPERIMENTAL] - Required, Immutable. The name of the schema for the gateway pipelines's storage location. + [Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location. """ connection_parameters: VariableOrOptional[ConnectionParametersParam] """ :meta private: [EXPERIMENTAL] - Optional, Internal. Parameters required to establish an initial connection with the source. + [Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source. """ gateway_storage_name: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Optional. The Unity Catalog-compatible name for the gateway storage location. + [Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location. This is the destination to use for the data that is extracted by the gateway. Spark Declarative Pipelines system will automatically create the storage location under the catalog and schema. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py index 050ca666636..20e1cfe78ca 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition.py @@ -39,7 +39,7 @@ class IngestionPipelineDefinition: connection_name: VariableOrOptional[str] = None """ - The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with + [Public Preview] The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with both connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle, (connector_type = QUERY_BASED OR connector_type = CDC). If connection name corresponds to database connectors like Oracle, and connector_type is not provided then @@ -51,12 +51,12 @@ class IngestionPipelineDefinition: connector_type: VariableOrOptional[ConnectorType] = None """ - (Optional) Connector Type for sources. Ex: CDC, Query Based. + [Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based. """ data_staging_options: VariableOrOptional[DataStagingOptions] = None """ - (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline + [Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline with Gateway pipeline to Combined Cdc Managed Ingestion Pipeline. If not specified, the volume for staged data will be created in catalog and schema/target specified in the top level pipeline definition. @@ -64,12 +64,12 @@ class IngestionPipelineDefinition: full_refresh_window: VariableOrOptional[OperationTimeWindow] = None """ - (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. + [Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. """ ingest_from_uc_foreign_catalog: VariableOrOptional[bool] = None """ - Immutable. If set to true, the pipeline will ingest tables from the + [Public Preview] Immutable. If set to true, the pipeline will ingest tables from the UC foreign catalogs directly without the need to specify a UC connection or ingestion gateway. The `source_catalog` fields in objects of IngestionConfig are interpreted as the UC foreign catalogs to ingest from. @@ -77,7 +77,7 @@ class IngestionPipelineDefinition: ingestion_gateway_id: VariableOrOptional[str] = None """ - Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. + [Public Preview] Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. This is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC). Under certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc Managed Ingestion Pipeline. @@ -86,21 +86,23 @@ class IngestionPipelineDefinition: netsuite_jar_path: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ objects: VariableOrList[IngestionConfig] = field(default_factory=list) """ - Required. Settings specifying tables to replicate and the destination for the replicated tables. + [Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables. """ source_configurations: VariableOrList[SourceConfig] = field(default_factory=list) """ - Top-level source configurations + [Public Preview] Top-level source configurations """ table_configuration: VariableOrOptional[TableSpecificConfig] = None """ - Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. + [Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. """ @classmethod @@ -116,7 +118,7 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): connection_name: VariableOrOptional[str] """ - The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with + [Public Preview] The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with both connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle, (connector_type = QUERY_BASED OR connector_type = CDC). If connection name corresponds to database connectors like Oracle, and connector_type is not provided then @@ -128,12 +130,12 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): connector_type: VariableOrOptional[ConnectorTypeParam] """ - (Optional) Connector Type for sources. Ex: CDC, Query Based. + [Beta] (Optional) Connector Type for sources. Ex: CDC, Query Based. """ data_staging_options: VariableOrOptional[DataStagingOptionsParam] """ - (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline + [Beta] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline with Gateway pipeline to Combined Cdc Managed Ingestion Pipeline. If not specified, the volume for staged data will be created in catalog and schema/target specified in the top level pipeline definition. @@ -141,12 +143,12 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): full_refresh_window: VariableOrOptional[OperationTimeWindowParam] """ - (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. + [Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. """ ingest_from_uc_foreign_catalog: VariableOrOptional[bool] """ - Immutable. If set to true, the pipeline will ingest tables from the + [Public Preview] Immutable. If set to true, the pipeline will ingest tables from the UC foreign catalogs directly without the need to specify a UC connection or ingestion gateway. The `source_catalog` fields in objects of IngestionConfig are interpreted as the UC foreign catalogs to ingest from. @@ -154,7 +156,7 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): ingestion_gateway_id: VariableOrOptional[str] """ - Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. + [Public Preview] Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. This is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC). Under certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc Managed Ingestion Pipeline. @@ -163,21 +165,23 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): netsuite_jar_path: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ objects: VariableOrList[IngestionConfigParam] """ - Required. Settings specifying tables to replicate and the destination for the replicated tables. + [Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables. """ source_configurations: VariableOrList[SourceConfigParam] """ - Top-level source configurations + [Public Preview] Top-level source configurations """ table_configuration: VariableOrOptional[TableSpecificConfigParam] """ - Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. + [Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_table_specific_config_query_based_connector_config.py b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_table_specific_config_query_based_connector_config.py index babdc662917..33a73ffa5c8 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_table_specific_config_query_based_connector_config.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_table_specific_config_query_based_connector_config.py @@ -17,7 +17,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig: cursor_columns: VariableOrList[str] = field(default_factory=list) """ - The names of the monotonically increasing columns in the source table that are used to enable + [Public Preview] The names of the monotonically increasing columns in the source table that are used to enable the table to be read and ingested incrementally through structured streaming. The columns are allowed to have repeated values but have to be non-decreasing. If the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these @@ -27,7 +27,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig: deletion_condition: VariableOrOptional[str] = None """ - Specifies a SQL WHERE condition that specifies that the source row has been deleted. + [Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted. This is sometimes referred to as "soft-deletes". For example: "Operation = 'DELETE'" or "is_deleted = true". This field is orthogonal to `hard_deletion_sync_interval_in_seconds`, @@ -38,7 +38,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig: hard_deletion_sync_min_interval_in_seconds: VariableOrOptional[int] = None """ - Specifies the minimum interval (in seconds) between snapshots on primary keys + [Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys for detecting and synchronizing hard deletions—i.e., rows that have been physically removed from the source table. This interval acts as a lower bound. If ingestion runs less frequently than @@ -68,7 +68,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfigDic cursor_columns: VariableOrList[str] """ - The names of the monotonically increasing columns in the source table that are used to enable + [Public Preview] The names of the monotonically increasing columns in the source table that are used to enable the table to be read and ingested incrementally through structured streaming. The columns are allowed to have repeated values but have to be non-decreasing. If the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these @@ -78,7 +78,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfigDic deletion_condition: VariableOrOptional[str] """ - Specifies a SQL WHERE condition that specifies that the source row has been deleted. + [Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted. This is sometimes referred to as "soft-deletes". For example: "Operation = 'DELETE'" or "is_deleted = true". This field is orthogonal to `hard_deletion_sync_interval_in_seconds`, @@ -89,7 +89,7 @@ class IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfigDic hard_deletion_sync_min_interval_in_seconds: VariableOrOptional[int] """ - Specifies the minimum interval (in seconds) between snapshots on primary keys + [Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys for detecting and synchronizing hard deletions—i.e., rows that have been physically removed from the source table. This interval acts as a lower bound. If ingestion runs less frequently than diff --git a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters.py b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters.py index 56e1840c791..c86ff492d22 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters.py @@ -19,7 +19,7 @@ class IngestionPipelineDefinitionWorkdayReportParameters: """ :meta private: [EXPERIMENTAL] - Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), + [Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), and the corresponding value is a SQL-like expression used to compute the parameter value at runtime. Example: { @@ -45,7 +45,7 @@ class IngestionPipelineDefinitionWorkdayReportParametersDict(TypedDict, total=Fa """ :meta private: [EXPERIMENTAL] - Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), + [Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), and the corresponding value is a SQL-like expression used to compute the parameter value at runtime. Example: { diff --git a/python/databricks/bundles/pipelines/_models/jira_connector_options.py b/python/databricks/bundles/pipelines/_models/jira_connector_options.py index b0d1e82582f..ed97e56ddfd 100644 --- a/python/databricks/bundles/pipelines/_models/jira_connector_options.py +++ b/python/databricks/bundles/pipelines/_models/jira_connector_options.py @@ -17,7 +17,7 @@ class JiraConnectorOptions: include_jira_spaces: VariableOrList[str] = field(default_factory=list) """ - (Optional) Projects to filter Jira data on + [Beta] (Optional) Projects to filter Jira data on """ @classmethod @@ -33,7 +33,7 @@ class JiraConnectorOptionsDict(TypedDict, total=False): include_jira_spaces: VariableOrList[str] """ - (Optional) Projects to filter Jira data on + [Beta] (Optional) Projects to filter Jira data on """ diff --git a/python/databricks/bundles/pipelines/_models/json_transformer_options.py b/python/databricks/bundles/pipelines/_models/json_transformer_options.py index dc00e759691..22c8d37956b 100644 --- a/python/databricks/bundles/pipelines/_models/json_transformer_options.py +++ b/python/databricks/bundles/pipelines/_models/json_transformer_options.py @@ -23,14 +23,14 @@ class JsonTransformerOptions: """ :meta private: [EXPERIMENTAL] - Parse the entire value as a single Variant column. + [Private Preview] Parse the entire value as a single Variant column. """ schema: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Inline schema string for JSON parsing (Spark DDL format). + [Private Preview] Inline schema string for JSON parsing (Spark DDL format). """ schema_evolution_mode: VariableOrOptional[ @@ -39,21 +39,21 @@ class JsonTransformerOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Schema evolution mode for schema inference. + [Private Preview] (Optional) Schema evolution mode for schema inference. """ schema_file_path: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Path to a schema file (.ddl). + [Private Preview] Path to a schema file (.ddl). """ schema_hints: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - (Optional) Schema hints as a comma-separated string of "column_name type" pairs. + [Private Preview] (Optional) Schema hints as a comma-separated string of "column_name type" pairs. """ @classmethod @@ -71,14 +71,14 @@ class JsonTransformerOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Parse the entire value as a single Variant column. + [Private Preview] Parse the entire value as a single Variant column. """ schema: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Inline schema string for JSON parsing (Spark DDL format). + [Private Preview] Inline schema string for JSON parsing (Spark DDL format). """ schema_evolution_mode: VariableOrOptional[ @@ -87,21 +87,21 @@ class JsonTransformerOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Schema evolution mode for schema inference. + [Private Preview] (Optional) Schema evolution mode for schema inference. """ schema_file_path: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Path to a schema file (.ddl). + [Private Preview] Path to a schema file (.ddl). """ schema_hints: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - (Optional) Schema hints as a comma-separated string of "column_name type" pairs. + [Private Preview] (Optional) Schema hints as a comma-separated string of "column_name type" pairs. """ diff --git a/python/databricks/bundles/pipelines/_models/kafka_options.py b/python/databricks/bundles/pipelines/_models/kafka_options.py index 9a33e5e1e3d..b37566a291b 100644 --- a/python/databricks/bundles/pipelines/_models/kafka_options.py +++ b/python/databricks/bundles/pipelines/_models/kafka_options.py @@ -27,7 +27,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - Undocumented backdoor mechanism for overriding parameters + [Private Preview] Undocumented backdoor mechanism for overriding parameters to pass to the Kafka client. This is not supported and may break at any time. """ @@ -36,7 +36,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Transformer for the message key. + [Private Preview] (Optional) Transformer for the message key. If not specified, the key is left as raw bytes. """ @@ -44,14 +44,14 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - Internal option to control the maximum number of offsets to process per trigger. + [Private Preview] Internal option to control the maximum number of offsets to process per trigger. """ starting_offset: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - (Optional) Where to begin reading when no checkpoint exists. + [Private Preview] (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest". """ @@ -59,7 +59,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - Java regex pattern to subscribe to matching topics. + [Private Preview] Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified. """ @@ -67,7 +67,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - Topics to subscribe to. + [Private Preview] Topics to subscribe to. Only one of topics or topic_pattern must be specified. """ @@ -75,7 +75,7 @@ class KafkaOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Transformer for the message value. + [Private Preview] (Optional) Transformer for the message value. If not specified, the value is left as raw bytes. """ @@ -94,7 +94,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Undocumented backdoor mechanism for overriding parameters + [Private Preview] Undocumented backdoor mechanism for overriding parameters to pass to the Kafka client. This is not supported and may break at any time. """ @@ -103,7 +103,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Transformer for the message key. + [Private Preview] (Optional) Transformer for the message key. If not specified, the key is left as raw bytes. """ @@ -111,14 +111,14 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Internal option to control the maximum number of offsets to process per trigger. + [Private Preview] Internal option to control the maximum number of offsets to process per trigger. """ starting_offset: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - (Optional) Where to begin reading when no checkpoint exists. + [Private Preview] (Optional) Where to begin reading when no checkpoint exists. Valid values: "latest" and "earliest". Defaults to "latest". """ @@ -126,7 +126,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Java regex pattern to subscribe to matching topics. + [Private Preview] Java regex pattern to subscribe to matching topics. Only one of topics or topic_pattern must be specified. """ @@ -134,7 +134,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Topics to subscribe to. + [Private Preview] Topics to subscribe to. Only one of topics or topic_pattern must be specified. """ @@ -142,7 +142,7 @@ class KafkaOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Transformer for the message value. + [Private Preview] (Optional) Transformer for the message value. If not specified, the value is left as raw bytes. """ diff --git a/python/databricks/bundles/pipelines/_models/meta_marketing_options.py b/python/databricks/bundles/pipelines/_models/meta_marketing_options.py index fb9d5b8f8ba..c78284427e3 100644 --- a/python/databricks/bundles/pipelines/_models/meta_marketing_options.py +++ b/python/databricks/bundles/pipelines/_models/meta_marketing_options.py @@ -17,44 +17,44 @@ class MetaMarketingOptions: action_attribution_windows: VariableOrList[str] = field(default_factory=list) """ - (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") + [Beta] (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") """ action_breakdowns: VariableOrList[str] = field(default_factory=list) """ - (Optional) Action breakdowns to configure for data aggregation + [Beta] (Optional) Action breakdowns to configure for data aggregation """ action_report_time: VariableOrOptional[str] = None """ - (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) + [Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) """ breakdowns: VariableOrList[str] = field(default_factory=list) """ - (Optional) Breakdowns to configure for data aggregation + [Beta] (Optional) Breakdowns to configure for data aggregation """ custom_insights_lookback_window: VariableOrOptional[int] = None """ - (Optional) Window in days to revisit data during sync to capture + [Beta] (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. """ level: VariableOrOptional[str] = None """ - (Optional) Granularity of data to pull (account, ad, adset, campaign) + [Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign) """ start_date: VariableOrOptional[str] = None """ - (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added + [Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested """ time_increment: VariableOrOptional[str] = None """ - (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) + [Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) """ @classmethod @@ -70,44 +70,44 @@ class MetaMarketingOptionsDict(TypedDict, total=False): action_attribution_windows: VariableOrList[str] """ - (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") + [Beta] (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") """ action_breakdowns: VariableOrList[str] """ - (Optional) Action breakdowns to configure for data aggregation + [Beta] (Optional) Action breakdowns to configure for data aggregation """ action_report_time: VariableOrOptional[str] """ - (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) + [Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) """ breakdowns: VariableOrList[str] """ - (Optional) Breakdowns to configure for data aggregation + [Beta] (Optional) Breakdowns to configure for data aggregation """ custom_insights_lookback_window: VariableOrOptional[int] """ - (Optional) Window in days to revisit data during sync to capture + [Beta] (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. """ level: VariableOrOptional[str] """ - (Optional) Granularity of data to pull (account, ad, adset, campaign) + [Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign) """ start_date: VariableOrOptional[str] """ - (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added + [Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested """ time_increment: VariableOrOptional[str] """ - (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) + [Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) """ diff --git a/python/databricks/bundles/pipelines/_models/operation_time_window.py b/python/databricks/bundles/pipelines/_models/operation_time_window.py index 85720ab6c1a..8acd9ea7bb8 100644 --- a/python/databricks/bundles/pipelines/_models/operation_time_window.py +++ b/python/databricks/bundles/pipelines/_models/operation_time_window.py @@ -22,18 +22,18 @@ class OperationTimeWindow: start_hour: VariableOr[int] """ - An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. + [Public Preview] An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. """ days_of_week: VariableOrList[DayOfWeek] = field(default_factory=list) """ - Days of week in which the window is allowed to happen + [Public Preview] Days of week in which the window is allowed to happen If not specified all days of the week will be used. """ time_zone_id: VariableOrOptional[str] = None """ - Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. + [Public Preview] Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. """ @@ -50,18 +50,18 @@ class OperationTimeWindowDict(TypedDict, total=False): start_hour: VariableOr[int] """ - An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. + [Public Preview] An integer between 0 and 23 denoting the start hour for the window in the 24-hour day. """ days_of_week: VariableOrList[DayOfWeekParam] """ - Days of week in which the window is allowed to happen + [Public Preview] Days of week in which the window is allowed to happen If not specified all days of the week will be used. """ time_zone_id: VariableOrOptional[str] """ - Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. + [Public Preview] Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details. If not specified, UTC will be used. """ diff --git a/python/databricks/bundles/pipelines/_models/outlook_options.py b/python/databricks/bundles/pipelines/_models/outlook_options.py index 5d88963498b..36fafbdfd91 100644 --- a/python/databricks/bundles/pipelines/_models/outlook_options.py +++ b/python/databricks/bundles/pipelines/_models/outlook_options.py @@ -29,7 +29,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Controls which attachments to ingest. + [Private Preview] (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. """ @@ -37,7 +37,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Defines how the body_content column is populated. + [Private Preview] (Optional) Defines how the body_content column is populated. TEXT_HTML: Preserves full formatting, links, and styling. TEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise. """ @@ -46,7 +46,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Filter mail folders to include in the sync. + [Private Preview] (Optional) Filter mail folders to include in the sync. If not specified, all folders will be synced. Examples: Inbox, Sent Items, Custom_Folder Filter semantics: OR between different folders. @@ -56,7 +56,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). + [Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). If not specified, all accessible mailboxes are ingested. Filter semantics: OR between different mailboxes. """ @@ -65,7 +65,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Filter emails by sender address. Uses exact email match. + [Private Preview] (Optional) Filter emails by sender address. Uses exact email match. Examples: user@vendor.com, alerts@system.io, noreply@company.com If not specified, emails from all senders will be synced. Filter semantics: OR between different senders. @@ -75,7 +75,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with + [Private Preview] (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with the part before "*"); otherwise substring match (subject contains the value). Examples: "Invoice" (substring), "Re:*" (prefix), "Support Ticket", "URGENT*" If not specified, emails with all subjects will be synced. @@ -86,7 +86,7 @@ class OutlookOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format. Format: YYYY-MM-DD (e.g., 2024-01-01) This determines the earliest date from which to sync historical data. If not specified, complete history is ingested. @@ -107,7 +107,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Controls which attachments to ingest. + [Private Preview] (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. """ @@ -115,7 +115,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Defines how the body_content column is populated. + [Private Preview] (Optional) Defines how the body_content column is populated. TEXT_HTML: Preserves full formatting, links, and styling. TEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise. """ @@ -124,7 +124,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Filter mail folders to include in the sync. + [Private Preview] (Optional) Filter mail folders to include in the sync. If not specified, all folders will be synced. Examples: Inbox, Sent Items, Custom_Folder Filter semantics: OR between different folders. @@ -134,7 +134,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). + [Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers). If not specified, all accessible mailboxes are ingested. Filter semantics: OR between different mailboxes. """ @@ -143,7 +143,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Filter emails by sender address. Uses exact email match. + [Private Preview] (Optional) Filter emails by sender address. Uses exact email match. Examples: user@vendor.com, alerts@system.io, noreply@company.com If not specified, emails from all senders will be synced. Filter semantics: OR between different senders. @@ -153,7 +153,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with + [Private Preview] (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with the part before "*"); otherwise substring match (subject contains the value). Examples: "Invoice" (substring), "Re:*" (prefix), "Support Ticket", "URGENT*" If not specified, emails with all subjects will be synced. @@ -164,7 +164,7 @@ class OutlookOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format. Format: YYYY-MM-DD (e.g., 2024-01-01) This determines the earliest date from which to sync historical data. If not specified, complete history is ingested. diff --git a/python/databricks/bundles/pipelines/_models/path_pattern.py b/python/databricks/bundles/pipelines/_models/path_pattern.py index e8e04fd949a..55ad00ebd38 100644 --- a/python/databricks/bundles/pipelines/_models/path_pattern.py +++ b/python/databricks/bundles/pipelines/_models/path_pattern.py @@ -15,7 +15,7 @@ class PathPattern: include: VariableOrOptional[str] = None """ - The source code to include for pipelines + [Public Preview] The source code to include for pipelines """ @classmethod @@ -31,7 +31,7 @@ class PathPatternDict(TypedDict, total=False): include: VariableOrOptional[str] """ - The source code to include for pipelines + [Public Preview] The source code to include for pipelines """ diff --git a/python/databricks/bundles/pipelines/_models/pipeline.py b/python/databricks/bundles/pipelines/_models/pipeline.py index 798db0a9bb8..5d23141c42f 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline.py +++ b/python/databricks/bundles/pipelines/_models/pipeline.py @@ -67,7 +67,7 @@ class Pipeline(Resource): budget_policy_id: VariableOrOptional[str] = None """ - Budget policy of this pipeline. + [Public Preview] Budget policy of this pipeline. """ catalog: VariableOrOptional[str] = None @@ -107,7 +107,7 @@ class Pipeline(Resource): environment: VariableOrOptional[PipelinesEnvironment] = None """ - Environment specification for this pipeline used to install dependencies. + [Public Preview] Environment specification for this pipeline used to install dependencies. """ event_log: VariableOrOptional[EventLogSpec] = None @@ -124,7 +124,7 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - The definition of a gateway pipeline to support change data capture. + [Private Preview] The definition of a gateway pipeline to support change data capture. """ id: VariableOrOptional[str] = None @@ -134,7 +134,7 @@ class Pipeline(Resource): ingestion_definition: VariableOrOptional[IngestionPipelineDefinition] = None """ - The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. + [Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. """ libraries: VariableOrList[PipelineLibrary] = field(default_factory=list) @@ -158,6 +158,9 @@ class Pipeline(Resource): """ parameters: VariableOrDict[str] = field(default_factory=dict) + """ + [Beta] + """ permissions: VariableOrList[PipelinePermission] = field(default_factory=list) @@ -170,12 +173,12 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - Restart window of this pipeline. + [Private Preview] Restart window of this pipeline. """ root_path: VariableOrOptional[str] = None """ - Root path for this pipeline. + [Public Preview] Root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline execution. """ @@ -213,7 +216,7 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - Usage policy of this pipeline. + [Private Preview] Usage policy of this pipeline. """ @classmethod @@ -234,7 +237,7 @@ class PipelineDict(TypedDict, total=False): budget_policy_id: VariableOrOptional[str] """ - Budget policy of this pipeline. + [Public Preview] Budget policy of this pipeline. """ catalog: VariableOrOptional[str] @@ -274,7 +277,7 @@ class PipelineDict(TypedDict, total=False): environment: VariableOrOptional[PipelinesEnvironmentParam] """ - Environment specification for this pipeline used to install dependencies. + [Public Preview] Environment specification for this pipeline used to install dependencies. """ event_log: VariableOrOptional[EventLogSpecParam] @@ -291,7 +294,7 @@ class PipelineDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The definition of a gateway pipeline to support change data capture. + [Private Preview] The definition of a gateway pipeline to support change data capture. """ id: VariableOrOptional[str] @@ -301,7 +304,7 @@ class PipelineDict(TypedDict, total=False): ingestion_definition: VariableOrOptional[IngestionPipelineDefinitionParam] """ - The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. + [Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. """ libraries: VariableOrList[PipelineLibraryParam] @@ -325,6 +328,9 @@ class PipelineDict(TypedDict, total=False): """ parameters: VariableOrDict[str] + """ + [Beta] + """ permissions: VariableOrList[PipelinePermissionParam] @@ -337,12 +343,12 @@ class PipelineDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Restart window of this pipeline. + [Private Preview] Restart window of this pipeline. """ root_path: VariableOrOptional[str] """ - Root path for this pipeline. + [Public Preview] Root path for this pipeline. This is used as the root directory when editing the pipeline in the Databricks user interface and it is added to sys.path when executing Python sources during pipeline execution. """ @@ -380,7 +386,7 @@ class PipelineDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Usage policy of this pipeline. + [Private Preview] Usage policy of this pipeline. """ diff --git a/python/databricks/bundles/pipelines/_models/pipeline_library.py b/python/databricks/bundles/pipelines/_models/pipeline_library.py index fa5b9e09e1c..90d048f9644 100644 --- a/python/databricks/bundles/pipelines/_models/pipeline_library.py +++ b/python/databricks/bundles/pipelines/_models/pipeline_library.py @@ -36,7 +36,7 @@ class PipelineLibrary: glob: VariableOrOptional[PathPattern] = None """ - The unified field to include source codes. + [Public Preview] The unified field to include source codes. Each entry can be a notebook path, a file path, or a folder path that ends `/**`. This field cannot be used together with `notebook` or `file`. """ @@ -45,14 +45,14 @@ class PipelineLibrary: """ :meta private: [EXPERIMENTAL] - URI of the jar to be installed. Currently only DBFS is supported. + [Private Preview] URI of the jar to be installed. Currently only DBFS is supported. """ maven: VariableOrOptional[MavenLibrary] = None """ :meta private: [EXPERIMENTAL] - Specification of a maven library to be installed. + [Private Preview] Specification of a maven library to be installed. """ notebook: VariableOrOptional[NotebookLibrary] = None @@ -78,7 +78,7 @@ class PipelineLibraryDict(TypedDict, total=False): glob: VariableOrOptional[PathPatternParam] """ - The unified field to include source codes. + [Public Preview] The unified field to include source codes. Each entry can be a notebook path, a file path, or a folder path that ends `/**`. This field cannot be used together with `notebook` or `file`. """ @@ -87,14 +87,14 @@ class PipelineLibraryDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - URI of the jar to be installed. Currently only DBFS is supported. + [Private Preview] URI of the jar to be installed. Currently only DBFS is supported. """ maven: VariableOrOptional[MavenLibraryParam] """ :meta private: [EXPERIMENTAL] - Specification of a maven library to be installed. + [Private Preview] Specification of a maven library to be installed. """ notebook: VariableOrOptional[NotebookLibraryParam] diff --git a/python/databricks/bundles/pipelines/_models/pipelines_environment.py b/python/databricks/bundles/pipelines/_models/pipelines_environment.py index 4a24f7e1e62..6f1850b9eb4 100644 --- a/python/databricks/bundles/pipelines/_models/pipelines_environment.py +++ b/python/databricks/bundles/pipelines/_models/pipelines_environment.py @@ -18,7 +18,7 @@ class PipelinesEnvironment: dependencies: VariableOrList[str] = field(default_factory=list) """ - List of pip dependencies, as supported by the version of pip in this environment. + [Public Preview] List of pip dependencies, as supported by the version of pip in this environment. Each dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/ Allowed dependency could be , , (WSFS or Volumes in Databricks), """ @@ -27,7 +27,7 @@ class PipelinesEnvironment: """ :meta private: [EXPERIMENTAL] - The environment version of the serverless Python environment used to execute + [Private Preview] The environment version of the serverless Python environment used to execute customer Python code. Each environment version includes a specific Python version and a curated set of pre-installed libraries with defined versions, providing a stable and reproducible execution environment. @@ -52,7 +52,7 @@ class PipelinesEnvironmentDict(TypedDict, total=False): dependencies: VariableOrList[str] """ - List of pip dependencies, as supported by the version of pip in this environment. + [Public Preview] List of pip dependencies, as supported by the version of pip in this environment. Each dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/ Allowed dependency could be , , (WSFS or Volumes in Databricks), """ @@ -61,7 +61,7 @@ class PipelinesEnvironmentDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - The environment version of the serverless Python environment used to execute + [Private Preview] The environment version of the serverless Python environment used to execute customer Python code. Each environment version includes a specific Python version and a curated set of pre-installed libraries with defined versions, providing a stable and reproducible execution environment. diff --git a/python/databricks/bundles/pipelines/_models/postgres_catalog_config.py b/python/databricks/bundles/pipelines/_models/postgres_catalog_config.py index 87092e7d7a7..a25c35870a9 100644 --- a/python/databricks/bundles/pipelines/_models/postgres_catalog_config.py +++ b/python/databricks/bundles/pipelines/_models/postgres_catalog_config.py @@ -21,7 +21,7 @@ class PostgresCatalogConfig: slot_config: VariableOrOptional[PostgresSlotConfig] = None """ - Optional. The Postgres slot configuration to use for logical replication + [Public Preview] Optional. The Postgres slot configuration to use for logical replication """ @classmethod @@ -37,7 +37,7 @@ class PostgresCatalogConfigDict(TypedDict, total=False): slot_config: VariableOrOptional[PostgresSlotConfigParam] """ - Optional. The Postgres slot configuration to use for logical replication + [Public Preview] Optional. The Postgres slot configuration to use for logical replication """ diff --git a/python/databricks/bundles/pipelines/_models/postgres_slot_config.py b/python/databricks/bundles/pipelines/_models/postgres_slot_config.py index 3c392c2d330..31db5806e62 100644 --- a/python/databricks/bundles/pipelines/_models/postgres_slot_config.py +++ b/python/databricks/bundles/pipelines/_models/postgres_slot_config.py @@ -17,12 +17,12 @@ class PostgresSlotConfig: publication_name: VariableOrOptional[str] = None """ - The name of the publication to use for the Postgres source + [Public Preview] The name of the publication to use for the Postgres source """ slot_name: VariableOrOptional[str] = None """ - The name of the logical replication slot to use for the Postgres source + [Public Preview] The name of the logical replication slot to use for the Postgres source """ @classmethod @@ -38,12 +38,12 @@ class PostgresSlotConfigDict(TypedDict, total=False): publication_name: VariableOrOptional[str] """ - The name of the publication to use for the Postgres source + [Public Preview] The name of the publication to use for the Postgres source """ slot_name: VariableOrOptional[str] """ - The name of the logical replication slot to use for the Postgres source + [Public Preview] The name of the logical replication slot to use for the Postgres source """ diff --git a/python/databricks/bundles/pipelines/_models/report_spec.py b/python/databricks/bundles/pipelines/_models/report_spec.py index 02d4a8760af..f2b6fc1aacd 100644 --- a/python/databricks/bundles/pipelines/_models/report_spec.py +++ b/python/databricks/bundles/pipelines/_models/report_spec.py @@ -19,27 +19,27 @@ class ReportSpec: destination_catalog: VariableOr[str] """ - Required. Destination catalog to store table. + [Public Preview] Required. Destination catalog to store table. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store table. + [Public Preview] Required. Destination schema to store table. """ source_url: VariableOr[str] """ - Required. Report URL in the source system. + [Public Preview] Required. Report URL in the source system. """ destination_table: VariableOrOptional[str] = None """ - Required. Destination table name. The pipeline fails if a table with that name already exists. + [Public Preview] Required. Destination table name. The pipeline fails if a table with that name already exists. """ table_configuration: VariableOrOptional[TableSpecificConfig] = None """ - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. + [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. """ @classmethod @@ -55,27 +55,27 @@ class ReportSpecDict(TypedDict, total=False): destination_catalog: VariableOr[str] """ - Required. Destination catalog to store table. + [Public Preview] Required. Destination catalog to store table. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store table. + [Public Preview] Required. Destination schema to store table. """ source_url: VariableOr[str] """ - Required. Report URL in the source system. + [Public Preview] Required. Report URL in the source system. """ destination_table: VariableOrOptional[str] """ - Required. Destination table name. The pipeline fails if a table with that name already exists. + [Public Preview] Required. Destination table name. The pipeline fails if a table with that name already exists. """ table_configuration: VariableOrOptional[TableSpecificConfigParam] """ - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. + [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. """ diff --git a/python/databricks/bundles/pipelines/_models/restart_window.py b/python/databricks/bundles/pipelines/_models/restart_window.py index b148614499e..dcc468b3ffc 100644 --- a/python/databricks/bundles/pipelines/_models/restart_window.py +++ b/python/databricks/bundles/pipelines/_models/restart_window.py @@ -24,7 +24,7 @@ class RestartWindow: """ :meta private: [EXPERIMENTAL] - An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. + [Private Preview] 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. """ @@ -32,7 +32,7 @@ class RestartWindow: """ :meta private: [EXPERIMENTAL] - Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). + [Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). If not specified all days of the week will be used. """ @@ -40,7 +40,7 @@ class RestartWindow: """ :meta private: [EXPERIMENTAL] - 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. + [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. If not specified, UTC will be used. """ @@ -59,7 +59,7 @@ class RestartWindowDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day. + [Private Preview] 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. """ @@ -67,7 +67,7 @@ class RestartWindowDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). + [Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour). If not specified all days of the week will be used. """ @@ -75,7 +75,7 @@ class RestartWindowDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - 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. + [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. If not specified, UTC will be used. """ diff --git a/python/databricks/bundles/pipelines/_models/schema_spec.py b/python/databricks/bundles/pipelines/_models/schema_spec.py index 9f756992026..a00c3b9334a 100644 --- a/python/databricks/bundles/pipelines/_models/schema_spec.py +++ b/python/databricks/bundles/pipelines/_models/schema_spec.py @@ -23,32 +23,32 @@ class SchemaSpec: destination_catalog: VariableOr[str] """ - Required. Destination catalog to store tables. + [Public Preview] Required. Destination catalog to store tables. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. + [Public Preview] Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. """ source_schema: VariableOr[str] """ - Required. Schema name in the source database. + [Public Preview] Required. Schema name in the source database. """ connector_options: VariableOrOptional[ConnectorOptions] = None """ - (Optional) Source Specific Connector Options + [Public Preview] (Optional) Source Specific Connector Options """ source_catalog: VariableOrOptional[str] = None """ - The source catalog name. Might be optional depending on the type of source. + [Public Preview] The source catalog name. Might be optional depending on the type of source. """ table_configuration: VariableOrOptional[TableSpecificConfig] = None """ - Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. + [Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. """ @classmethod @@ -64,32 +64,32 @@ class SchemaSpecDict(TypedDict, total=False): destination_catalog: VariableOr[str] """ - Required. Destination catalog to store tables. + [Public Preview] Required. Destination catalog to store tables. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. + [Public Preview] Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists. """ source_schema: VariableOr[str] """ - Required. Schema name in the source database. + [Public Preview] Required. Schema name in the source database. """ connector_options: VariableOrOptional[ConnectorOptionsParam] """ - (Optional) Source Specific Connector Options + [Public Preview] (Optional) Source Specific Connector Options """ source_catalog: VariableOrOptional[str] """ - The source catalog name. Might be optional depending on the type of source. + [Public Preview] The source catalog name. Might be optional depending on the type of source. """ table_configuration: VariableOrOptional[TableSpecificConfigParam] """ - Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. + [Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object. """ diff --git a/python/databricks/bundles/pipelines/_models/sharepoint_options.py b/python/databricks/bundles/pipelines/_models/sharepoint_options.py index 8bf678ab886..6f5994995a7 100644 --- a/python/databricks/bundles/pipelines/_models/sharepoint_options.py +++ b/python/databricks/bundles/pipelines/_models/sharepoint_options.py @@ -27,7 +27,7 @@ class SharepointOptions: """ :meta private: [EXPERIMENTAL] - (Optional) The type of SharePoint entity to ingest. + [Private Preview] (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. """ @@ -35,14 +35,14 @@ class SharepointOptions: """ :meta private: [EXPERIMENTAL] - (Optional) File ingestion options for processing files. + [Private Preview] (Optional) File ingestion options for processing files. """ url: VariableOrOptional[str] = None """ :meta private: [EXPERIMENTAL] - Required. The SharePoint URL. + [Private Preview] Required. The SharePoint URL. """ @classmethod @@ -60,7 +60,7 @@ class SharepointOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) The type of SharePoint entity to ingest. + [Private Preview] (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. """ @@ -68,14 +68,14 @@ class SharepointOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) File ingestion options for processing files. + [Private Preview] (Optional) File ingestion options for processing files. """ url: VariableOrOptional[str] """ :meta private: [EXPERIMENTAL] - Required. The SharePoint URL. + [Private Preview] Required. The SharePoint URL. """ diff --git a/python/databricks/bundles/pipelines/_models/smartsheet_options.py b/python/databricks/bundles/pipelines/_models/smartsheet_options.py index 061bf1e6000..d378d8ec2a0 100644 --- a/python/databricks/bundles/pipelines/_models/smartsheet_options.py +++ b/python/databricks/bundles/pipelines/_models/smartsheet_options.py @@ -21,7 +21,7 @@ class SmartsheetOptions: """ :meta private: [EXPERIMENTAL] - (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/ + [Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/ Checkbox/etc.). Cells that do not conform to the declared type are set to NULL. When false, all columns land as STRING. Use false for sheets with irregular data or columns that frequently violate their own declared type. @@ -43,7 +43,7 @@ class SmartsheetOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/ + [Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/ Checkbox/etc.). Cells that do not conform to the declared type are set to NULL. When false, all columns land as STRING. Use false for sheets with irregular data or columns that frequently violate their own declared type. diff --git a/python/databricks/bundles/pipelines/_models/source_catalog_config.py b/python/databricks/bundles/pipelines/_models/source_catalog_config.py index 246079cee0f..e61521e1f3f 100644 --- a/python/databricks/bundles/pipelines/_models/source_catalog_config.py +++ b/python/databricks/bundles/pipelines/_models/source_catalog_config.py @@ -21,12 +21,12 @@ class SourceCatalogConfig: postgres: VariableOrOptional[PostgresCatalogConfig] = None """ - Postgres-specific catalog-level configuration parameters + [Public Preview] Postgres-specific catalog-level configuration parameters """ source_catalog: VariableOrOptional[str] = None """ - Source catalog name + [Public Preview] Source catalog name """ @classmethod @@ -42,12 +42,12 @@ class SourceCatalogConfigDict(TypedDict, total=False): postgres: VariableOrOptional[PostgresCatalogConfigParam] """ - Postgres-specific catalog-level configuration parameters + [Public Preview] Postgres-specific catalog-level configuration parameters """ source_catalog: VariableOrOptional[str] """ - Source catalog name + [Public Preview] Source catalog name """ diff --git a/python/databricks/bundles/pipelines/_models/source_config.py b/python/databricks/bundles/pipelines/_models/source_config.py index ebbef1ef02c..afd2bae632f 100644 --- a/python/databricks/bundles/pipelines/_models/source_config.py +++ b/python/databricks/bundles/pipelines/_models/source_config.py @@ -23,12 +23,14 @@ class SourceConfig: catalog: VariableOrOptional[SourceCatalogConfig] = None """ - Catalog-level source configuration parameters + [Public Preview] Catalog-level source configuration parameters """ google_ads_config: VariableOrOptional[GoogleAdsConfig] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -44,12 +46,14 @@ class SourceConfigDict(TypedDict, total=False): catalog: VariableOrOptional[SourceCatalogConfigParam] """ - Catalog-level source configuration parameters + [Public Preview] Catalog-level source configuration parameters """ google_ads_config: VariableOrOptional[GoogleAdsConfigParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/pipelines/_models/table_spec.py b/python/databricks/bundles/pipelines/_models/table_spec.py index 10f5eb8ad1e..e2240ac360a 100644 --- a/python/databricks/bundles/pipelines/_models/table_spec.py +++ b/python/databricks/bundles/pipelines/_models/table_spec.py @@ -23,42 +23,42 @@ class TableSpec: destination_catalog: VariableOr[str] """ - Required. Destination catalog to store table. + [Public Preview] Required. Destination catalog to store table. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store table. + [Public Preview] Required. Destination schema to store table. """ source_table: VariableOr[str] """ - Required. Table name in the source database. + [Public Preview] Required. Table name in the source database. """ connector_options: VariableOrOptional[ConnectorOptions] = None """ - (Optional) Source Specific Connector Options + [Public Preview] (Optional) Source Specific Connector Options """ destination_table: VariableOrOptional[str] = None """ - Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. + [Public Preview] Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. """ source_catalog: VariableOrOptional[str] = None """ - Source catalog name. Might be optional depending on the type of source. + [Public Preview] Source catalog name. Might be optional depending on the type of source. """ source_schema: VariableOrOptional[str] = None """ - Schema name in the source database. Might be optional depending on the type of source. + [Public Preview] Schema name in the source database. Might be optional depending on the type of source. """ table_configuration: VariableOrOptional[TableSpecificConfig] = None """ - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. + [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. """ @classmethod @@ -74,42 +74,42 @@ class TableSpecDict(TypedDict, total=False): destination_catalog: VariableOr[str] """ - Required. Destination catalog to store table. + [Public Preview] Required. Destination catalog to store table. """ destination_schema: VariableOr[str] """ - Required. Destination schema to store table. + [Public Preview] Required. Destination schema to store table. """ source_table: VariableOr[str] """ - Required. Table name in the source database. + [Public Preview] Required. Table name in the source database. """ connector_options: VariableOrOptional[ConnectorOptionsParam] """ - (Optional) Source Specific Connector Options + [Public Preview] (Optional) Source Specific Connector Options """ destination_table: VariableOrOptional[str] """ - Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. + [Public Preview] Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used. """ source_catalog: VariableOrOptional[str] """ - Source catalog name. Might be optional depending on the type of source. + [Public Preview] Source catalog name. Might be optional depending on the type of source. """ source_schema: VariableOrOptional[str] """ - Schema name in the source database. Might be optional depending on the type of source. + [Public Preview] Schema name in the source database. Might be optional depending on the type of source. """ table_configuration: VariableOrOptional[TableSpecificConfigParam] """ - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. + [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. """ diff --git a/python/databricks/bundles/pipelines/_models/table_specific_config.py b/python/databricks/bundles/pipelines/_models/table_specific_config.py index 57e7fe2b1fe..117869fe710 100644 --- a/python/databricks/bundles/pipelines/_models/table_specific_config.py +++ b/python/databricks/bundles/pipelines/_models/table_specific_config.py @@ -31,7 +31,7 @@ class TableSpecificConfig: auto_full_refresh_policy: VariableOrOptional[AutoFullRefreshPolicy] = None """ - (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try + [Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try to fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy in table configuration will override the above level auto_full_refresh_policy. For example, @@ -46,7 +46,7 @@ class TableSpecificConfig: exclude_columns: VariableOrList[str] = field(default_factory=list) """ - A list of column names to be excluded for the ingestion. + [Public Preview] A list of column names to be excluded for the ingestion. When not specified, include_columns fully controls what columns to be ingested. When specified, all other columns including future ones will be automatically included for ingestion. This field in mutually exclusive with `include_columns`. @@ -54,7 +54,7 @@ class TableSpecificConfig: include_columns: VariableOrList[str] = field(default_factory=list) """ - A list of column names to be included for the ingestion. + [Public Preview] A list of column names to be included for the ingestion. When not specified, all columns except ones in exclude_columns will be included. Future columns will be automatically included. When specified, all other future columns will be automatically excluded from ingestion. @@ -63,19 +63,19 @@ class TableSpecificConfig: primary_keys: VariableOrList[str] = field(default_factory=list) """ - The primary key of the table used to apply changes. + [Public Preview] The primary key of the table used to apply changes. """ query_based_connector_config: VariableOrOptional[ IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig ] = None """ - Configurations that are only applicable for query-based ingestion connectors. + [Public Preview] Configurations that are only applicable for query-based ingestion connectors. """ row_filter: VariableOrOptional[str] = None """ - (Optional, Immutable) The row filter condition to be applied to the table. + [Public Preview] (Optional, Immutable) The row filter condition to be applied to the table. It must not contain the WHERE keyword, only the actual filter condition. It must be in DBSQL format. """ @@ -84,17 +84,17 @@ class TableSpecificConfig: """ :meta private: [EXPERIMENTAL] - If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector + [Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector """ scd_type: VariableOrOptional[TableSpecificConfigScdType] = None """ - The SCD type to use to ingest the table. + [Public Preview] The SCD type to use to ingest the table. """ sequence_by: VariableOrList[str] = field(default_factory=list) """ - The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. + [Public Preview] The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. """ workday_report_parameters: VariableOrOptional[ @@ -102,6 +102,8 @@ class TableSpecificConfig: ] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -117,7 +119,7 @@ class TableSpecificConfigDict(TypedDict, total=False): auto_full_refresh_policy: VariableOrOptional[AutoFullRefreshPolicyParam] """ - (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try + [Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try to fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy in table configuration will override the above level auto_full_refresh_policy. For example, @@ -132,7 +134,7 @@ class TableSpecificConfigDict(TypedDict, total=False): exclude_columns: VariableOrList[str] """ - A list of column names to be excluded for the ingestion. + [Public Preview] A list of column names to be excluded for the ingestion. When not specified, include_columns fully controls what columns to be ingested. When specified, all other columns including future ones will be automatically included for ingestion. This field in mutually exclusive with `include_columns`. @@ -140,7 +142,7 @@ class TableSpecificConfigDict(TypedDict, total=False): include_columns: VariableOrList[str] """ - A list of column names to be included for the ingestion. + [Public Preview] A list of column names to be included for the ingestion. When not specified, all columns except ones in exclude_columns will be included. Future columns will be automatically included. When specified, all other future columns will be automatically excluded from ingestion. @@ -149,19 +151,19 @@ class TableSpecificConfigDict(TypedDict, total=False): primary_keys: VariableOrList[str] """ - The primary key of the table used to apply changes. + [Public Preview] The primary key of the table used to apply changes. """ query_based_connector_config: VariableOrOptional[ IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfigParam ] """ - Configurations that are only applicable for query-based ingestion connectors. + [Public Preview] Configurations that are only applicable for query-based ingestion connectors. """ row_filter: VariableOrOptional[str] """ - (Optional, Immutable) The row filter condition to be applied to the table. + [Public Preview] (Optional, Immutable) The row filter condition to be applied to the table. It must not contain the WHERE keyword, only the actual filter condition. It must be in DBSQL format. """ @@ -170,17 +172,17 @@ class TableSpecificConfigDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector + [Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector """ scd_type: VariableOrOptional[TableSpecificConfigScdTypeParam] """ - The SCD type to use to ingest the table. + [Public Preview] The SCD type to use to ingest the table. """ sequence_by: VariableOrList[str] """ - The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. + [Public Preview] The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order. """ workday_report_parameters: VariableOrOptional[ @@ -188,6 +190,8 @@ class TableSpecificConfigDict(TypedDict, total=False): ] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py b/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py index d37064947a1..a4a814b78b5 100644 --- a/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py +++ b/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py @@ -29,7 +29,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Data level for the report. + [Private Preview] (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. """ @@ -37,7 +37,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Dimensions to include in the report. + [Private Preview] (Optional) Dimensions to include in the report. Examples: "campaign_id", "adgroup_id", "ad_id", "stat_time_day", "stat_time_hour" If not specified, defaults to campaign_id. """ @@ -46,7 +46,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Number of days to look back for report tables during incremental sync + [Private Preview] (Optional) Number of days to look back for report tables during incremental sync to capture late-arriving conversions and attribution data. If not specified, defaults to 7 days. """ @@ -55,7 +55,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Metrics to include in the report. + [Private Preview] (Optional) Metrics to include in the report. Examples: "spend", "impressions", "clicks", "conversion", "cpc" If not specified, defaults to basic metrics (spend, impressions, clicks, etc.) """ @@ -64,7 +64,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Whether to request lifetime metrics (all-time aggregated data). + [Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data). When true, the report returns all-time data. If not specified, defaults to false. """ @@ -73,7 +73,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Report type for the TikTok Ads API. + [Private Preview] (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. """ @@ -81,7 +81,7 @@ class TikTokAdsOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. If not specified, defaults to 1 year of historical data for daily reports and 30 days for hourly reports. @@ -102,7 +102,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Data level for the report. + [Private Preview] (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. """ @@ -110,7 +110,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Dimensions to include in the report. + [Private Preview] (Optional) Dimensions to include in the report. Examples: "campaign_id", "adgroup_id", "ad_id", "stat_time_day", "stat_time_hour" If not specified, defaults to campaign_id. """ @@ -119,7 +119,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Number of days to look back for report tables during incremental sync + [Private Preview] (Optional) Number of days to look back for report tables during incremental sync to capture late-arriving conversions and attribution data. If not specified, defaults to 7 days. """ @@ -128,7 +128,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Metrics to include in the report. + [Private Preview] (Optional) Metrics to include in the report. Examples: "spend", "impressions", "clicks", "conversion", "cpc" If not specified, defaults to basic metrics (spend, impressions, clicks, etc.) """ @@ -137,7 +137,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Whether to request lifetime metrics (all-time aggregated data). + [Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data). When true, the report returns all-time data. If not specified, defaults to false. """ @@ -146,7 +146,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Report type for the TikTok Ads API. + [Private Preview] (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. """ @@ -154,7 +154,7 @@ class TikTokAdsOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. + [Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data. If not specified, defaults to 1 year of historical data for daily reports and 30 days for hourly reports. diff --git a/python/databricks/bundles/pipelines/_models/transformer.py b/python/databricks/bundles/pipelines/_models/transformer.py index 53c2a05eeca..84af0aa9d98 100644 --- a/python/databricks/bundles/pipelines/_models/transformer.py +++ b/python/databricks/bundles/pipelines/_models/transformer.py @@ -29,12 +29,14 @@ class Transformer: """ :meta private: [EXPERIMENTAL] - Required: the wire format of the data. + [Private Preview] Required: the wire format of the data. """ json_options: VariableOrOptional[JsonTransformerOptions] = None """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ @classmethod @@ -52,12 +54,14 @@ class TransformerDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - Required: the wire format of the data. + [Private Preview] Required: the wire format of the data. """ json_options: VariableOrOptional[JsonTransformerOptionsParam] """ :meta private: [EXPERIMENTAL] + + [Private Preview] """ diff --git a/python/databricks/bundles/pipelines/_models/zendesk_support_options.py b/python/databricks/bundles/pipelines/_models/zendesk_support_options.py index 2a4e85f02f4..21339a398eb 100644 --- a/python/databricks/bundles/pipelines/_models/zendesk_support_options.py +++ b/python/databricks/bundles/pipelines/_models/zendesk_support_options.py @@ -21,7 +21,7 @@ class ZendeskSupportOptions: """ :meta private: [EXPERIMENTAL] - (Optional) Start date in YYYY-MM-DD format for the initial sync. + [Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync. This determines the earliest date from which to sync historical data. """ @@ -40,7 +40,7 @@ class ZendeskSupportOptionsDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Start date in YYYY-MM-DD format for the initial sync. + [Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync. This determines the earliest date from which to sync historical data. """