From d0d5ccbad71304e3e75f0a0a3c5ebe9f138106e6 Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Wed, 27 May 2026 17:11:16 +0200 Subject: [PATCH 1/7] Annotate schema description with launch stage --- bundle/docsgen/main.go | 42 +++++++++++++++++++- bundle/internal/annotation/descriptor.go | 1 + bundle/internal/schema/annotations.go | 49 +++++++++++++++++++++++- bundle/internal/schema/parser.go | 46 ++++++++++++++++++---- libs/jsonschema/extension.go | 5 +++ 5 files changed, 131 insertions(+), 12 deletions(-) diff --git a/bundle/docsgen/main.go b/bundle/docsgen/main.go index c06811ebbdd..b8bf40028c8 100644 --- a/bundle/docsgen/main.go +++ b/bundle/docsgen/main.go @@ -139,13 +139,51 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { s.Deprecated = true s.DeprecationMessage = a.DeprecationMessage } - if a.Preview == "PRIVATE" { - s.DoNotSuggest = true + if a.Preview != "" { s.Preview = a.Preview + if a.Preview == "PRIVATE" { + s.DoNotSuggest = true + } + } + if a.LaunchStage != "" { + s.LaunchStage = a.LaunchStage + switch a.LaunchStage { + case "PRIVATE_PREVIEW", "DEVELOPMENT": + s.DoNotSuggest = true + } } if a.OutputOnly != nil && *a.OutputOnly { s.DoNotSuggest = true } + + if tag := previewTag(a.LaunchStage, a.Preview); tag != "" { + if s.Description != "" { + s.Description = tag + " " + s.Description + } else { + s.Description = tag + } + } +} + +// previewTag returns the human-readable launch-stage prefix to prepend to a +// field's description. LaunchStage is preferred over Preview because it carries +// the richer signal (Beta vs. Public Preview), falling back to the legacy +// Preview field when only that's available. +func previewTag(launchStage, preview string) string { + switch launchStage { + case "PRIVATE_PREVIEW": + return "[Private Preview]" + case "PUBLIC_BETA": + return "[Public Beta]" + case "PUBLIC_PREVIEW": + return "[Public Preview]" + case "DEVELOPMENT": + return "[Development]" + } + if preview == "PRIVATE" { + return "[Private Preview]" + } + return "" } func fillTemplateVariables(s string) string { diff --git a/bundle/internal/annotation/descriptor.go b/bundle/internal/annotation/descriptor.go index 797746b0df8..bf727cfc6c6 100644 --- a/bundle/internal/annotation/descriptor.go +++ b/bundle/internal/annotation/descriptor.go @@ -9,6 +9,7 @@ type Descriptor struct { 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"` OutputOnly *bool `json:"x-databricks-field-behaviors_output_only,omitempty"` } diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index 26b9dcfc0de..5b42eba6788 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -134,9 +134,19 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { s.DeprecationMessage = a.DeprecationMessage } - if a.Preview == "PRIVATE" { - s.DoNotSuggest = true + if a.Preview != "" { s.Preview = a.Preview + if a.Preview == "PRIVATE" { + s.DoNotSuggest = true + } + } + + if a.LaunchStage != "" { + s.LaunchStage = a.LaunchStage + switch a.LaunchStage { + case "PRIVATE_PREVIEW", "DEVELOPMENT": + s.DoNotSuggest = true + } } if a.OutputOnly != nil && *a.OutputOnly { @@ -146,6 +156,41 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { s.MarkdownDescription = convertLinksToAbsoluteUrl(a.MarkdownDescription) s.Title = a.Title s.Enum = a.Enum + + // Surface launch stage in hover tooltips. Editors generally only render the + // standard description field, so we tag it directly rather than rely on + // consumers reading x-databricks-launch-stage / x-databricks-preview. + if tag := previewTag(a.LaunchStage, a.Preview); tag != "" { + s.Description = prefixWithPreviewTag(s.Description, tag) + } +} + +// previewTag returns the human-readable launch-stage prefix to prepend to a +// field's description. LaunchStage is preferred over Preview because it carries +// the richer signal (Beta vs. Public Preview), falling back to the legacy +// Preview field when only that's available. +func previewTag(launchStage, preview string) string { + switch launchStage { + case "PRIVATE_PREVIEW": + return "[Private Preview]" + case "PUBLIC_BETA": + return "[Public Beta]" + case "PUBLIC_PREVIEW": + return "[Public Preview]" + case "DEVELOPMENT": + return "[Development]" + } + if preview == "PRIVATE" { + return "[Private Preview]" + } + return "" +} + +func prefixWithPreviewTag(description, tag string) string { + if description == "" { + return tag + } + return tag + " " + description } func saveYamlWithStyle(outputPath string, annotations annotation.File) error { diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index d72524dc59c..db5a8b71f2e 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -124,6 +124,26 @@ func isOutputOnly(s jsonschema.Schema) *bool { return &res } +// normalizePreview drops PUBLIC (the GA value for x-databricks-preview) so it +// isn't persisted in the annotation file. PRIVATE is preserved. +func normalizePreview(preview string) string { + if preview == "PUBLIC" { + return "" + } + return preview +} + +// normalizeLaunchStage drops the GA / unspecified values of +// x-databricks-launch-stage so they aren't persisted in the annotation file. +// The proto definition states GA is the default when the field is absent. +func normalizeLaunchStage(launchStage string) string { + switch launchStage { + case "GA", "LAUNCH_STAGE_UNSPECIFIED": + return "" + } + return launchStage +} + // Use the OpenAPI spec to load descriptions for the given type. func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overridesPath string) error { annotations := annotation.File{} @@ -155,12 +175,16 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid basePath := getPath(typ) pkg := map[string]annotation.Descriptor{} annotations[basePath] = pkg - preview := ref.Preview - if preview == "PUBLIC" { - preview = "" - } + preview := normalizePreview(ref.Preview) + launchStage := normalizeLaunchStage(ref.LaunchStage) outputOnly := isOutputOnly(ref) - if ref.Description != "" || ref.Enum != nil || ref.Deprecated || ref.DeprecationMessage != "" || preview != "" || outputOnly != nil { + // Skip extraction for DEVELOPMENT-stage types so their descriptions + // don't leak into the public annotations file. Genkit drops these + // from the SDK; this is a defense in depth for the schema extractor. + if launchStage == "DEVELOPMENT" { + return s + } + if ref.Description != "" || ref.Enum != nil || ref.Deprecated || ref.DeprecationMessage != "" || preview != "" || launchStage != "" || outputOnly != nil { if ref.Deprecated && ref.DeprecationMessage == "" { ref.DeprecationMessage = "This field is deprecated" } @@ -170,15 +194,20 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid Enum: ref.Enum, DeprecationMessage: ref.DeprecationMessage, Preview: preview, + LaunchStage: launchStage, OutputOnly: outputOnly, } } for k := range s.Properties { if refProp, ok := ref.Properties[k]; ok { - preview = refProp.Preview - if preview == "PUBLIC" { - preview = "" + preview = normalizePreview(refProp.Preview) + launchStage = normalizeLaunchStage(refProp.LaunchStage) + + // Skip DEVELOPMENT-stage properties for the same reason as + // the root type above. + if launchStage == "DEVELOPMENT" { + continue } if refProp.Deprecated && refProp.DeprecationMessage == "" { @@ -202,6 +231,7 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid Description: description, Enum: refProp.Enum, Preview: preview, + LaunchStage: launchStage, DeprecationMessage: refProp.DeprecationMessage, OutputOnly: isOutputOnly(*refProp), } diff --git a/libs/jsonschema/extension.go b/libs/jsonschema/extension.go index 0bc23afcb1b..767bb93f36f 100644 --- a/libs/jsonschema/extension.go +++ b/libs/jsonschema/extension.go @@ -48,6 +48,11 @@ type Extension struct { // from the generated Sphinx documentation. Preview string `json:"x-databricks-preview,omitempty"` + // LaunchStage indicates the field's launch stage from the OpenAPI spec + // (PRIVATE_PREVIEW, PUBLIC_BETA, PUBLIC_PREVIEW, GA). It is the richer + // counterpart to Preview, which only distinguishes PRIVATE vs PUBLIC. + LaunchStage string `json:"x-databricks-launch-stage,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 From 35b7235bcb19f1abf938c1c1831acebb96412f67 Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Thu, 4 Jun 2026 14:01:17 +0200 Subject: [PATCH 2/7] Surface per-enum-value launch stage via enumDescriptions Add per-enum-value plumbing on top of the field-level launch-stage support: - libs/jsonschema/extension.go: EnumMetadata + EnumValueMetadata for parsing x-databricks-enum-metadata from the OpenAPI spec; EnumDescriptionMap for x-databricks-enum-descriptions; EnumDescriptions []string for the output schema's parallel enumDescriptions array. - bundle/internal/annotation/descriptor.go: EnumLaunchStages and EnumDescriptions maps so the per-value data persists in annotations_openapi.yml. - bundle/internal/schema/parser.go: extractEnumLaunchStages and extractEnumDescriptions helpers; wired into extractAnnotations on both the root-type and per-property paths. - bundle/internal/schema/annotations.go: buildEnumDescriptions builds the parallel []string aligned 1:1 with Enum. enumDescriptionLabel formats one entry; previewTagShort returns the compact bracketed label ([PuPr], [Beta], [PrPr]) so VSCode can render per-value status next to each enum value in autocomplete dropdowns. - Unit tests cover buildEnumDescriptions (all paths, including non-string entries), extractEnumLaunchStages, extractEnumDescriptions, and assignAnnotation's per-value behavior. Schema regeneration is deferred until the DEVELOPMENT-value filter lands in the next commit, so we only regenerate once. Co-authored-by: Isaac --- bundle/internal/annotation/descriptor.go | 11 +- bundle/internal/schema/annotations.go | 56 ++++++++ bundle/internal/schema/annotations_test.go | 148 +++++++++++++++++++++ bundle/internal/schema/parser.go | 49 ++++++- libs/jsonschema/extension.go | 24 ++++ 5 files changed, 286 insertions(+), 2 deletions(-) diff --git a/bundle/internal/annotation/descriptor.go b/bundle/internal/annotation/descriptor.go index bf727cfc6c6..f294d593872 100644 --- a/bundle/internal/annotation/descriptor.go +++ b/bundle/internal/annotation/descriptor.go @@ -10,7 +10,16 @@ type Descriptor struct { DeprecationMessage string `json:"deprecation_message,omitempty"` Preview string `json:"x-databricks-preview,omitempty"` LaunchStage string `json:"x-databricks-launch-stage,omitempty"` - OutputOnly *bool `json:"x-databricks-field-behaviors_output_only,omitempty"` + // EnumLaunchStages maps each non-GA enum value to its launch stage + // (e.g. STORAGE_OPTIMIZED -> PUBLIC_PREVIEW). Extracted from the OpenAPI + // spec's x-databricks-enum-metadata so per-value status can be surfaced. + EnumLaunchStages map[string]string `json:"x-databricks-enum-launch-stages,omitempty"` + // EnumDescriptions maps each enum value to its textual description, sourced + // from the OpenAPI spec's x-databricks-enum-descriptions block. Combined + // with EnumLaunchStages at schema-gen time to populate the parallel + // enumDescriptions array VSCode renders in autocomplete dropdowns. + 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/schema/annotations.go b/bundle/internal/schema/annotations.go index 5b42eba6788..ab1dc4a2355 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -156,6 +156,7 @@ 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 generally only render the // standard description field, so we tag it directly rather than rely on @@ -165,6 +166,61 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { } } +// buildEnumDescriptions produces the parallel enumDescriptions array VSCode +// renders next to each enum value. Each entry combines the short launch-stage +// label and the per-value description text. Returns nil when every entry would +// be empty so the field is omitted from the schema. +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] = enumDescriptionLabel(launchStages[key], descriptions[key]) + if result[i] != "" { + hasContent = true + } + } + if !hasContent { + return nil + } + return result +} + +// enumDescriptionLabel formats a single enumDescriptions entry. The launch +// stage is wrapped in brackets so it visually separates from the description +// in VSCode's autocomplete dropdown; an empty stage leaves the description +// alone, and a missing description leaves just the bracketed stage. +func enumDescriptionLabel(launchStage, description string) string { + short := previewTagShort(launchStage) + switch { + case short != "" && description != "": + return short + " " + description + case short != "": + return short + } + return description +} + +// previewTagShort is the compact counterpart to previewTag, used for per-enum- +// value labels where vertical space in the dropdown is tighter. +func previewTagShort(launchStage string) string { + switch launchStage { + case "PRIVATE_PREVIEW": + return "[PrPr]" + case "PUBLIC_BETA": + return "[Beta]" + case "PUBLIC_PREVIEW": + return "[PuPr]" + } + return "" +} + // previewTag returns the human-readable launch-stage prefix to prepend to a // field's description. LaunchStage is preferred over Preview because it carries // the richer signal (Beta vs. Public Preview), falling back to the legacy diff --git a/bundle/internal/schema/annotations_test.go b/bundle/internal/schema/annotations_test.go index 0e159335967..073af1a1a0b 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,147 @@ func TestConvertLinksToAbsoluteUrl(t *testing.T) { } } } + +func TestAssignAnnotationLaunchStage(t *testing.T) { + t.Run("field-level launch stage prefixes description", 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.Equal(t, "PUBLIC_PREVIEW", s.LaunchStage) + assert.False(t, s.DoNotSuggest) + }) + + t.Run("PRIVATE_PREVIEW also hides from autocomplete", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "Internal field.", + LaunchStage: "PRIVATE_PREVIEW", + }) + assert.Equal(t, "[Private Preview] Internal field.", s.Description) + assert.True(t, s.DoNotSuggest) + }) + + t.Run("launch stage takes precedence over legacy preview field", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "A field.", + Preview: "PRIVATE", + LaunchStage: "PUBLIC_BETA", + }) + assert.Equal(t, "[Public Beta] A field.", s.Description) + }) + + 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) + }) +} + +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{ + "[PuPr] Storage-optimized endpoint.", + "Standard endpoint.", + }, got) + }) + + t.Run("launch stage only emits bracketed short 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{"[PuPr]", "", "[Beta]"}, got) + }) +} + +func TestExtractEnumLaunchStages(t *testing.T) { + t.Run("drops GA, keeps preview values", func(t *testing.T) { + got := extractEnumLaunchStages(map[string]jsonschema.EnumValueMetadata{ + "STORAGE_OPTIMIZED": {LaunchStage: "PUBLIC_PREVIEW"}, + "STANDARD": {LaunchStage: "GA"}, + }) + assert.Equal(t, map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, got) + }) + + t.Run("returns nil when nothing notable remains", func(t *testing.T) { + assert.Nil(t, extractEnumLaunchStages(map[string]jsonschema.EnumValueMetadata{ + "STANDARD": {LaunchStage: "GA"}, + })) + }) + + t.Run("returns nil for empty metadata", func(t *testing.T) { + assert.Nil(t, extractEnumLaunchStages(nil)) + }) +} + +func TestExtractEnumDescriptions(t *testing.T) { + t.Run("keeps non-empty descriptions", func(t *testing.T) { + got := extractEnumDescriptions(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 := extractEnumDescriptions(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, extractEnumDescriptions(nil)) + assert.Nil(t, extractEnumDescriptions(map[string]string{})) + }) +} diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index db5a8b71f2e..bf42ac27a06 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -144,6 +144,47 @@ func normalizeLaunchStage(launchStage string) string { return launchStage } +// extractEnumLaunchStages pulls per-enum-value launch stages out of an +// OpenAPI spec's x-databricks-enum-metadata block, dropping GA/unspecified +// values. Returns nil when nothing remains so the descriptor stays clean. +func extractEnumLaunchStages(metadata map[string]jsonschema.EnumValueMetadata) map[string]string { + if len(metadata) == 0 { + return nil + } + result := map[string]string{} + for value, meta := range metadata { + ls := normalizeLaunchStage(meta.LaunchStage) + if ls == "" { + continue + } + result[value] = ls + } + if len(result) == 0 { + return nil + } + return result +} + +// extractEnumDescriptions pulls per-enum-value textual descriptions from an +// OpenAPI spec's x-databricks-enum-descriptions block. Returns nil when +// nothing remains so the descriptor stays clean. +func extractEnumDescriptions(descriptions map[string]string) map[string]string { + if len(descriptions) == 0 { + return nil + } + result := map[string]string{} + for value, desc := range descriptions { + if desc == "" { + continue + } + result[value] = desc + } + if len(result) == 0 { + return nil + } + return result +} + // Use the OpenAPI spec to load descriptions for the given type. func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overridesPath string) error { annotations := annotation.File{} @@ -177,6 +218,8 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid annotations[basePath] = pkg preview := normalizePreview(ref.Preview) launchStage := normalizeLaunchStage(ref.LaunchStage) + enumLaunchStages := extractEnumLaunchStages(ref.EnumMetadata) + enumDescriptions := extractEnumDescriptions(ref.EnumDescriptionMap) outputOnly := isOutputOnly(ref) // Skip extraction for DEVELOPMENT-stage types so their descriptions // don't leak into the public annotations file. Genkit drops these @@ -184,7 +227,7 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid if launchStage == "DEVELOPMENT" { return s } - if ref.Description != "" || ref.Enum != nil || ref.Deprecated || ref.DeprecationMessage != "" || preview != "" || launchStage != "" || outputOnly != nil { + if ref.Description != "" || ref.Enum != nil || ref.Deprecated || ref.DeprecationMessage != "" || preview != "" || launchStage != "" || enumLaunchStages != nil || enumDescriptions != nil || outputOnly != nil { if ref.Deprecated && ref.DeprecationMessage == "" { ref.DeprecationMessage = "This field is deprecated" } @@ -195,6 +238,8 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid DeprecationMessage: ref.DeprecationMessage, Preview: preview, LaunchStage: launchStage, + EnumLaunchStages: enumLaunchStages, + EnumDescriptions: enumDescriptions, OutputOnly: outputOnly, } } @@ -232,6 +277,8 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid Enum: refProp.Enum, Preview: preview, LaunchStage: launchStage, + EnumLaunchStages: extractEnumLaunchStages(refProp.EnumMetadata), + EnumDescriptions: extractEnumDescriptions(refProp.EnumDescriptionMap), DeprecationMessage: refProp.DeprecationMessage, OutputOnly: isOutputOnly(*refProp), } diff --git a/libs/jsonschema/extension.go b/libs/jsonschema/extension.go index 767bb93f36f..1a99cc28aac 100644 --- a/libs/jsonschema/extension.go +++ b/libs/jsonschema/extension.go @@ -53,6 +53,24 @@ type Extension struct { // counterpart to Preview, which only distinguishes PRIVATE vs PUBLIC. LaunchStage string `json:"x-databricks-launch-stage,omitempty"` + // EnumMetadata carries per-enum-value metadata from the OpenAPI spec + // (notably x-databricks-launch-stage). The CLI only consumes this when + // parsing OpenAPI specs to extract annotations; it isn't emitted in the + // generated bundle schema. + EnumMetadata map[string]EnumValueMetadata `json:"x-databricks-enum-metadata,omitempty"` + + // EnumDescriptionMap mirrors the OpenAPI spec's x-databricks-enum-descriptions + // block (enum value -> textual description). Populated when parsing OpenAPI + // specs; not emitted in the generated bundle schema (EnumDescriptions is + // emitted instead). + EnumDescriptionMap map[string]string `json:"x-databricks-enum-descriptions,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 x-databricks-enum-metadata and x-databricks-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 @@ -74,3 +92,9 @@ type Extension struct { // SinceVersion indicates which CLI version introduced this field. SinceVersion string `json:"x-since-version,omitempty"` } + +// EnumValueMetadata mirrors the per-enum-value metadata block from the +// OpenAPI spec (see universe/openapi/openapi/openapi.go:EnumMetadata). +type EnumValueMetadata struct { + LaunchStage string `json:"x-databricks-launch-stage,omitempty"` +} From 6685546d051764f801c4e993d02fe8df53219b67 Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Thu, 4 Jun 2026 14:05:12 +0200 Subject: [PATCH 3/7] Filter DEVELOPMENT enum values out of the bundle schema Genkit drops DEVELOPMENT-stage enum values when generating the SDK, so the SDK Go types have no constants for them. The CLI's annotation extractor didn't mirror that and copied the OpenAPI spec's enum list verbatim, causing values like vectorsearch.EndpointType.STANDARD_ON_ORION to land in bundle/schema/jsonschema.json on every regen. IDE schema validation would accept them; deploys would fail server-side. Fix: - bundle/internal/schema/parser.go: add filterDevelopmentEnumValues helper that drops any enum value whose x-databricks-enum-metadata marks it DEVELOPMENT. Wire it into extractAnnotations on both the root-type and per-property paths (Enum: filterDevelopmentEnumValues(...)). Also skip DEVELOPMENT entries in extractEnumLaunchStages and extractEnumDescriptions so the per-value metadata can't reintroduce the value names through a side channel. - bundle/internal/schema/annotations_test.go: add TestFilterDevelopmentEnumValues and extend the per-value extraction tests with DEVELOPMENT cases. - bundle/internal/schema/illegal-enum-in-schema.md: document why the filter exists (genkit's behavior is the source of truth) so future readers don't reintroduce the divergence. - bundle/internal/schema/sync-missing-annotations.md: track an orthogonal follow-up (stale PLACEHOLDER entries in annotations.yml) that surfaced while validating this work. - Regenerated bundle/internal/schema/annotations_openapi.yml, bundle/schema/jsonschema.json, bundle/schema/jsonschema_for_docs.json with the filter active. STANDARD_ON_ORION and any other DEVELOPMENT-stage enum values are gone. Co-authored-by: Isaac --- .../internal/schema/annotations_openapi.yml | 1552 +++++++++++-- bundle/internal/schema/annotations_test.go | 70 +- bundle/internal/schema/parser.go | 52 +- bundle/schema/jsonschema.json | 2027 +++++++++++------ bundle/schema/jsonschema_for_docs.json | 1570 +++++++++---- 5 files changed, 3946 insertions(+), 1325 deletions(-) diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml index 23c5770dcc0..3f1569a570a 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,7 +108,9 @@ 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_size": {} "compute_status": "x-databricks-field-behaviors_output_only": |- @@ -103,14 +137,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 @@ -127,9 +167,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 @@ -151,9 +195,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. @@ -174,8 +222,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": |- @@ -256,15 +308,14 @@ github.com/databricks/cli/bundle/config/resources.Cluster: Data security mode decides what data governance model to use when accessing data from a cluster. - The following modes can only be used when `kind = CLASSIC_PREVIEW`. * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration. - * `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`. - * `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`. + * `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. + * `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. - The following modes can be used regardless of `kind`. - * `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode. - * `SINGLE_USER`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. - * `USER_ISOLATION`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + The following modes are legacy aliases for the above modes: + + * `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. + * `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed for future Databricks Runtime versions: @@ -325,7 +376,6 @@ github.com/databricks/cli/bundle/config/resources.Cluster: Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not. * [is_single_node](/api/workspace/clusters/create#is_single_node) * [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) - * [data_security_mode](/api/workspace/clusters/create#data_security_mode) set to `DATA_SECURITY_MODE_AUTO`, `DATA_SECURITY_MODE_DEDICATED`, or `DATA_SECURITY_MODE_STANDARD` By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. "node_type_id": @@ -405,19 +455,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": |- @@ -425,25 +485,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. @@ -453,6 +523,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. @@ -460,6 +532,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. @@ -467,6 +541,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. @@ -474,6 +550,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 @@ -482,6 +560,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 @@ -490,6 +570,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. @@ -497,6 +579,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. @@ -504,62 +588,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": |- @@ -611,6 +723,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. @@ -706,6 +820,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": @@ -771,6 +887,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. @@ -799,6 +917,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 @@ -808,6 +928,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": @@ -816,6 +938,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. @@ -831,6 +955,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: "restart_window": "description": |- Restart window of this pipeline. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "root_path": @@ -838,6 +964,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. @@ -870,6 +998,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: @@ -888,6 +1018,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": {} @@ -1084,12 +1216,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 @@ -1098,6 +1234,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. @@ -1105,6 +1243,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. @@ -1117,12 +1257,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 @@ -1130,24 +1276,32 @@ 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 "name": "description": |- - Name of the vector search endpoint + Name of the AI Search endpoint "target_qps": "description": |- 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.Volume: @@ -1466,8 +1620,6 @@ github.com/databricks/databricks-sdk-go/service/apps.ComputeSize: MEDIUM - |- LARGE - - |- - LIQUID github.com/databricks/databricks-sdk-go/service/apps.ComputeState: "_": "enum": @@ -1493,6 +1645,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": @@ -1677,6 +1831,8 @@ github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificatio "enabled": "description": |- Whether to enable data classification. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination: "email_addresses": "description": |- @@ -1760,6 +1916,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: @@ -1881,30 +2039,6 @@ github.com/databricks/databricks-sdk-go/service/catalog.Privilege: EXECUTE_CLEAN_ROOM_TASK - |- EXTERNAL_USE_SCHEMA - - |- - VIEW_OBJECT - - |- - MANAGE_GRANTS - - |- - INSERT - - |- - UPDATE - - |- - DELETE - - |- - VIEW_ADMIN_METADATA - - |- - VIEW_METADATA - - |- - USE_VOLUME - - |- - READ_METADATA - - |- - MANAGE_ACCESS - - |- - MANAGE_ACCESS_CONTROL - - |- - CREATE_SERVICE github.com/databricks/databricks-sdk-go/service/catalog.PrivilegeAssignment: "principal": "description": |- @@ -2192,15 +2326,14 @@ github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec: Data security mode decides what data governance model to use when accessing data from a cluster. - The following modes can only be used when `kind = CLASSIC_PREVIEW`. * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration. - * `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`. - * `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`. + * `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. + * `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. + + The following modes are legacy aliases for the above modes: - The following modes can be used regardless of `kind`. - * `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode. - * `SINGLE_USER`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. - * `USER_ISOLATION`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + * `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. + * `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed for future Databricks Runtime versions: @@ -2261,7 +2394,6 @@ github.com/databricks/databricks-sdk-go/service/compute.ClusterSpec: Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with no specified `kind` do not. * [is_single_node](/api/workspace/clusters/create#is_single_node) * [use_ml_runtime](/api/workspace/clusters/create#use_ml_runtime) - * [data_security_mode](/api/workspace/clusters/create#data_security_mode) set to `DATA_SECURITY_MODE_AUTO`, `DATA_SECURITY_MODE_DEDICATED`, or `DATA_SECURITY_MODE_STANDARD` By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`. "node_type_id": @@ -2352,21 +2484,25 @@ 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": |- Data security mode decides what data governance model to use when accessing data from a cluster. - The following modes can only be used when `kind = CLASSIC_PREVIEW`. * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration. - * `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`. - * `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`. + * `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. + * `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. - The following modes can be used regardless of `kind`. - * `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode. - * `SINGLE_USER`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode. - * `USER_ISOLATION`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited. + The following modes are legacy aliases for the above modes: + + * `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. + * `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed for future Databricks Runtime versions: @@ -2396,6 +2532,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": |- @@ -2439,7 +2594,10 @@ github.com/databricks/databricks-sdk-go/service/compute.Environment: (e.g., `/Workspace/path/to/env.yaml`). Support for a Databricks-provided base environment ID (e.g., `workspace-base-environments/databricks_ai_v4`) and workspace base environment ID (e.g., `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) is in Beta. - Either `environment_version` or `base_environment` can be provided. For more information, see + Either `environment_version` or `base_environment` can be provided. + For more information about Databricks-provided base environments, see the + [list workspace base environments](:method:Environments/ListWorkspaceBaseEnvironments) API. + For more information, see "client": "description": |- Use `environment_version` instead. @@ -2458,6 +2616,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": |- @@ -2474,6 +2634,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": @@ -2542,8 +2704,11 @@ github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType: GPU_1xA10 - |- GPU_8xH100 - - |- - GPU_1xH100 + "x-databricks-enum-launch-stages": + "GPU_1xA10": |- + PUBLIC_BETA + "GPU_8xH100": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/compute.InitScriptInfo: "_": "description": |- @@ -2738,9 +2903,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": |- @@ -2761,6 +2930,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 @@ -2771,20 +2942,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": @@ -2800,8 +2979,19 @@ github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceState: UPDATING - |- FAILING_OVER - - |- - MIGRATING + "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": |- @@ -2809,11 +2999,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": |- @@ -2822,18 +3016,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": @@ -2849,6 +3049,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": @@ -2858,6 +3071,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": |- @@ -2868,17 +3088,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": |- @@ -2892,12 +3118,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": |- @@ -2907,42 +3137,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 @@ -2951,6 +3197,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": |- @@ -2962,6 +3210,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": @@ -2971,6 +3221,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": |- @@ -2979,6 +3236,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. @@ -2986,6 +3245,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. @@ -2994,18 +3255,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": |- @@ -3033,6 +3304,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": |- @@ -3041,15 +3335,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. @@ -3064,25 +3364,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": |- @@ -3093,17 +3403,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": |- @@ -3149,34 +3465,49 @@ github.com/databricks/databricks-sdk-go/service/iam.PermissionLevel: CAN_MONITOR_ONLY - |- CAN_CREATE_APP - - |- - UNSPECIFIED + "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_BETA "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_BETA "warehouse_id": "description": |- The warehouse_id identifies the warehouse settings used by the alert task. + "x-databricks-launch-stage": |- + PUBLIC_BETA "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_BETA 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_BETA "user_name": "description": |- A valid workspace email address. + "x-databricks-launch-stage": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod: "_": "enum": @@ -3184,6 +3515,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": |- @@ -3206,16 +3542,24 @@ 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 "gpu_type": "description": |- GPU type. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "num_gpus": "description": |- Number of GPUs. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.Condition: "_": "enum": @@ -3288,6 +3632,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": @@ -3304,16 +3650,24 @@ 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 "dbt_cloud_job_id": "description": |- Id of the dbt Cloud job to be triggered + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW 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 "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 github.com/databricks/databricks-sdk-go/service/jobs.DbtTask: "catalog": "description": |- @@ -3378,30 +3732,46 @@ github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask: "command": "description": |- Command launcher to run the actual script, e.g. bash, python etc. - "compute": {} + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW + "compute": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "dl_runtime_image": "description": |- Runtime image + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "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 "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 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 "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 "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 "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 github.com/databricks/databricks-sdk-go/service/jobs.GitProvider: "_": "enum": @@ -3459,6 +3829,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": {} @@ -3490,6 +3862,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": |- @@ -3502,6 +3882,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": |- @@ -3523,6 +3908,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. @@ -3570,6 +3957,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": @@ -3589,12 +3978,18 @@ 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 "import_from_git_branch": "description": |- Name of the branch which the job is imported from. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "job_config_path": "description": |- Path of the job YAML file that contains the job specification. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState: "_": "description": |- @@ -3609,6 +4004,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": |- @@ -3630,6 +4035,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": |- @@ -3662,22 +4078,32 @@ 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 "condition": "description": |- The condition based on which to trigger a job run. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "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 "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 "wait_after_last_change_seconds": "description": |- 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 github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition: "_": "enum": @@ -3687,6 +4113,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": |- @@ -3766,47 +4199,75 @@ 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.PythonWheelTask: "entry_point": "description": |- @@ -3849,6 +4310,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": |- @@ -3857,6 +4331,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": @@ -3870,6 +4346,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": @@ -3892,6 +4370,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": @@ -3900,6 +4380,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": @@ -3917,6 +4399,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": @@ -3934,6 +4418,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": @@ -3943,6 +4429,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: @@ -3959,6 +4447,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": |- @@ -4083,6 +4576,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": |- @@ -4122,6 +4622,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_BETA "clean_rooms_notebook_task": "description": |- The task runs a [clean rooms](https://docs.databricks.com/clean-rooms/index.html) notebook @@ -4129,6 +4631,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. @@ -4141,9 +4645,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": @@ -4162,8 +4670,6 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: "disabled": "description": |- An optional flag to disable the task. If set to true, the task will not run even if it is part of a job. - "x-databricks-preview": |- - PRIVATE "email_notifications": "description": |- An optional set of email addresses that is notified when runs of this task begin or complete as well as when this task is deleted. The default behavior is to not send any emails. @@ -4180,6 +4686,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": @@ -4213,6 +4721,8 @@ 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_wheel_task": "description": |- The task runs a Python wheel when the `python_wheel_task` field is present. @@ -4286,6 +4796,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. @@ -4316,6 +4828,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": @@ -4343,6 +4857,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. @@ -4399,11 +4915,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": |- @@ -4411,6 +4931,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": |- @@ -4418,6 +4940,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: @@ -4427,7 +4951,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": @@ -4435,35 +4963,51 @@ 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 "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: @@ -4477,6 +5021,11 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType: CDC - |- QUERY_BASED + "x-databricks-enum-launch-stages": + "CDC": |- + PRIVATE_PREVIEW + "QUERY_BASED": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.CronTrigger: "quartz_cron_schedule": {} "timezone_id": {} @@ -4487,9 +5036,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": |- + PRIVATE_PREVIEW "schema_name": "description": |- (Required, Immutable) The name of the schema for the connector's staging storage location. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "volume_name": "description": |- (Optional) The Unity Catalog-compatible name for the storage location. @@ -4497,6 +5050,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": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek: "_": "description": |- @@ -4517,6 +5072,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": |- @@ -4544,42 +5114,70 @@ 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 "modified_before": "description": |- 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 "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 github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions: - "corrupt_record_column": {} + "corrupt_record_column": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "file_filters": "description": |- Generic options + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "format": "description": |- required for TableSpec + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "format_options": "description": |- Format-specific options Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options - "ignore_corrupt_files": {} - "infer_column_types": {} + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW + "ignore_corrupt_files": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW + "infer_column_types": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "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 - "rescued_data_column": {} + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW + "rescued_data_column": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "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 "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 - "single_variant_column": {} + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW + "single_variant_column": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat: "_": "enum": @@ -4599,6 +5197,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": |- @@ -4614,6 +5229,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": |- @@ -4633,6 +5259,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 github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions: "_": "description": |- @@ -4643,22 +5271,34 @@ 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 "manager_account_id": "description": |- (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 "sync_start_date": "description": |- (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 github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions: - "entity_type": {} - "file_ingestion_options": {} + "entity_type": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW + "file_ingestion_options": + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "url": "description": |- Google Drive URL. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType: "_": "enum": @@ -4668,41 +5308,66 @@ 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 "connection_name": "description": |- Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "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 "gateway_storage_name": "description": |- 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 "gateway_storage_schema": "description": |- Required, Immutable. The name of the schema for the gateway pipelines's storage location. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition: "connection_name": "description": |- @@ -4714,9 +5379,13 @@ 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": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "data_staging_options": @@ -4725,36 +5394,50 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin 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": |- + PRIVATE_PREVIEW "x-databricks-preview": |- PRIVATE "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. @@ -4762,9 +5445,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": |- @@ -4777,6 +5464,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. @@ -4786,6 +5475,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 @@ -4796,6 +5487,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": |- @@ -4804,6 +5497,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 "parameters": "description": |- Parameters for the Workday report. Each key represents the parameter name (e.g., "start_date", "end_date"), @@ -4813,16 +5508,22 @@ 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 "report_parameters": "description": |- (Optional) Additional custom parameters for Workday Report This field is deprecated and should not be used. Use `parameters` instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW 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 "value": "description": |- Value for the report parameter. @@ -4830,6 +5531,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 github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: "_": "enum": @@ -4837,10 +5540,6 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: MYSQL - |- POSTGRESQL - - |- - REDSHIFT - - |- - SQLDW - |- SQLSERVER - |- @@ -4873,168 +5572,51 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionSourceType: CONFLUENCE - |- META_MARKETING - - |- - GOOGLE_ADS - - |- - TIKTOK_ADS - - |- - SALESFORCE_MARKETING_CLOUD - - |- - HUBSPOT - - |- - WORKDAY_HCM - - |- - GUIDEWIRE - |- ZENDESK - - |- - COMMUNITY - - |- - SLACK_AUDIT_LOGS - - |- - KAFKA - - |- - CROWDSTRIKE_EVENT_STREAM - - |- - WORKDAY_ACTIVITY_LOGGING - - |- - AKAMAI_WAF - - |- - VEEVA - - |- - VEEVA_VAULT - - |- - M365_AUDIT_LOGS - - |- - OKTA_SYSTEM_LOGS - - |- - ONE_PASSWORD_EVENT_LOGS - - |- - PROOFPOINT_SIEM - - |- - WIZ_AUDIT_LOGS - - |- - GITHUB - - |- - OUTLOOK - - |- - SMARTSHEET - - |- - MICROSOFT_TEAMS - - |- - ADOBE_CAMPAIGNS - - |- - LINKEDIN_ADS - - |- - X_ADS - - |- - BING_ADS - - |- - GOOGLE_SEARCH_CONSOLE - - |- - PINTEREST_ADS - - |- - REDDIT_ADS - - |- - PENDO - - |- - API_SOURCE - - |- - SLACK_ACCESS_AND_INTEGRATION_LOGS - - |- - ORACLE_FUSION_CLOUD - - |- - RABBITMQ - - |- - GOOGLE_ANALYTICS - - |- - AMPLITUDE - - |- - NOTION - - |- - ADP_WORKFORCE_NOW - - |- - SAS - - |- - GONG - - |- - SALESLOFT - - |- - GOOGLE_WORKSPACE - - |- - SHOPIFY - - |- - ORACLE_ELOQUA - - |- - EPIC_CLARITY - - |- - LINEAR - - |- - APPLE_APP_STORE - - |- - SPLUNK - - |- - GITLAB - - |- - ZOOM_LOGS - - |- - MONDAY_COM - - |- - AIRTABLE - - |- - MICROSOFT_ENTRA_ID - - |- - PAGERDUTY - - |- - APPFIGURES - - |- - ADOBE_COMMERCE - - |- - QUICKBOOKS - - |- - SQUARE - - |- - ZOHO_BOOKS - - |- - SNAPCHAT_ADS - - |- - GENESYS - - |- - SAP_SUCCESSFACTORS - - |- - YOUTUBE_ANALYTICS - - |- - CERIDIAN_DAYFORCE - - |- - FRESHSERVICE - - |- - SENDGRID - - |- - AZURE_MONITOR_LOGS - - |- - ATLASSIAN_ORGANIZATION - - |- - HIBOB - - |- - APPLE_SEARCH_ADS - - |- - AWIN - - |- - DELIGHTED - - |- - FRONT - - |- - GURU - - |- - PARTNERSTACK - - |- - MARKETO - - |- - AHA - - |- - NETSKOPE_LOGS - |- FOREIGN_CATALOG + "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": |- @@ -5042,6 +5624,8 @@ 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.ManualTrigger: {} github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions: "_": @@ -5050,29 +5634,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": |- @@ -5098,13 +5698,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": |- @@ -5118,6 +5724,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": |- @@ -5127,6 +5742,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": |- @@ -5135,33 +5755,45 @@ 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 "body_format": "description": |- (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 "folder_filter": "description": |- Deprecated. Use include_folders instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "include_folders": "description": |- (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. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "include_mailboxes": "description": |- (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 "include_senders": "description": |- (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. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "include_subjects": "description": |- (Optional) Filter emails by subject line. Values ending with "*" use prefix match (subject starts with @@ -5169,26 +5801,36 @@ 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 "sender_filter": "description": |- Deprecated. Use include_senders instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "start_date": "description": |- (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. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "subject_filter": "description": |- Deprecated. Use include_subjects instead. "deprecation_message": |- This field is deprecated + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW 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": |- @@ -5331,14 +5973,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": @@ -5375,6 +6023,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 @@ -5387,6 +6037,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: @@ -5396,6 +6048,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": |- @@ -5403,38 +6057,58 @@ 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 "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 "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 github.com/databricks/databricks-sdk-go/service/pipelines.RunAs: "_": "description": |- @@ -5451,32 +6125,50 @@ 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 "file_ingestion_options": "description": |- (Optional) File ingestion options for processing files. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "url": "description": |- Required. The SharePoint URL. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType: "_": "enum": @@ -5488,6 +6180,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": |- @@ -5499,6 +6200,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 github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig: "_": "description": |- @@ -5506,41 +6209,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": |- @@ -5555,12 +6282,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. @@ -5568,31 +6299,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: @@ -5606,6 +6353,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": |- @@ -5614,36 +6368,50 @@ 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 "dimensions": "description": |- (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 "lookback_window_days": "description": |- (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 "metrics": "description": |- (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 "query_lifetime": "description": |- (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 "report_type": "description": |- (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW "sync_start_date": "description": |- (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. + "x-databricks-launch-stage": |- + PRIVATE_PREVIEW github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel: "_": "description": |- @@ -5657,6 +6425,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": |- @@ -5674,6 +6451,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.ZendeskSupportOptions: "_": "description": |- @@ -5682,20 +6472,28 @@ 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 github.com/databricks/databricks-sdk-go/service/postgres.EndpointGroupSpec: "enable_readable_secondaries": "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": |- @@ -5703,6 +6501,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": |- @@ -5712,13 +6512,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": |- @@ -5726,22 +6553,50 @@ 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": |- + Scheduling policy of the synced table's underlying pipeline. + "enum": + - |- + CONTINUOUS + - |- + 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": |- @@ -5763,6 +6618,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. @@ -5781,22 +6638,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": @@ -5806,13 +6673,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": |- @@ -5857,11 +6735,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": |- @@ -5921,6 +6811,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": |- @@ -6115,6 +7014,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": |- @@ -6250,11 +7168,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": @@ -6269,6 +7195,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**. @@ -6282,6 +7210,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. @@ -6300,6 +7230,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. @@ -6315,12 +7247,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. @@ -6341,6 +7277,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. @@ -6365,6 +7303,11 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInputWorkload GPU_LARGE - |- MULTIGPU_MEDIUM + - |- + GPU_XLARGE + "x-databricks-enum-launch-stages": + "GPU_XLARGE": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/serving.ServingEndpointPermissionLevel: "_": "description": |- @@ -6391,6 +7334,11 @@ github.com/databricks/databricks-sdk-go/service/serving.ServingModelWorkloadType GPU_LARGE - |- MULTIGPU_MEDIUM + - |- + GPU_XLARGE + "x-databricks-enum-launch-stages": + "GPU_XLARGE": |- + PUBLIC_BETA github.com/databricks/databricks-sdk-go/service/serving.TrafficConfig: "routes": "description": |- @@ -6414,6 +7362,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": |- @@ -6431,6 +7396,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": @@ -6438,65 +7412,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": |- @@ -6533,6 +7556,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": @@ -6542,21 +7582,25 @@ github.com/databricks/databricks-sdk-go/service/sql.CreateWarehouseRequestWareho CLASSIC - |- PRO - - |- - REYDEN 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": {} @@ -6569,6 +7613,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": |- @@ -6621,8 +7670,9 @@ github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType: STORAGE_OPTIMIZED - |- STANDARD - - |- - STANDARD_ON_ORION + "x-databricks-enum-launch-stages": + "STORAGE_OPTIMIZED": |- + PUBLIC_PREVIEW 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 073af1a1a0b..b625c624014 100644 --- a/bundle/internal/schema/annotations_test.go +++ b/bundle/internal/schema/annotations_test.go @@ -148,10 +148,11 @@ func TestBuildEnumDescriptions(t *testing.T) { } func TestExtractEnumLaunchStages(t *testing.T) { - t.Run("drops GA, keeps preview values", func(t *testing.T) { + t.Run("drops DEVELOPMENT and GA, keeps preview values", func(t *testing.T) { got := extractEnumLaunchStages(map[string]jsonschema.EnumValueMetadata{ "STORAGE_OPTIMIZED": {LaunchStage: "PUBLIC_PREVIEW"}, "STANDARD": {LaunchStage: "GA"}, + "STANDARD_ON_ORION": {LaunchStage: "DEVELOPMENT"}, }) assert.Equal(t, map[string]string{"STORAGE_OPTIMIZED": "PUBLIC_PREVIEW"}, got) }) @@ -169,10 +170,13 @@ func TestExtractEnumLaunchStages(t *testing.T) { func TestExtractEnumDescriptions(t *testing.T) { t.Run("keeps non-empty descriptions", func(t *testing.T) { - got := extractEnumDescriptions(map[string]string{ - "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", - "STANDARD": "Standard endpoint.", - }) + got := extractEnumDescriptions( + map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "Standard endpoint.", + }, + nil, + ) assert.Equal(t, map[string]string{ "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", "STANDARD": "Standard endpoint.", @@ -180,17 +184,63 @@ func TestExtractEnumDescriptions(t *testing.T) { }) t.Run("drops empty descriptions", func(t *testing.T) { - got := extractEnumDescriptions(map[string]string{ + got := extractEnumDescriptions( + map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD": "", + }, + nil, + ) + assert.Equal(t, map[string]string{ "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", - "STANDARD": "", - }) + }, got) + }) + + t.Run("drops descriptions for DEVELOPMENT values", func(t *testing.T) { + got := extractEnumDescriptions( + map[string]string{ + "STORAGE_OPTIMIZED": "Storage-optimized endpoint.", + "STANDARD_ON_ORION": "Top-secret prototype.", + }, + map[string]jsonschema.EnumValueMetadata{ + "STANDARD_ON_ORION": {LaunchStage: "DEVELOPMENT"}, + }, + ) 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, extractEnumDescriptions(nil)) - assert.Nil(t, extractEnumDescriptions(map[string]string{})) + assert.Nil(t, extractEnumDescriptions(nil, nil)) + assert.Nil(t, extractEnumDescriptions(map[string]string{}, nil)) + }) +} + +func TestFilterDevelopmentEnumValues(t *testing.T) { + t.Run("drops DEVELOPMENT values, keeps the rest", func(t *testing.T) { + got := filterDevelopmentEnumValues( + []any{"STORAGE_OPTIMIZED", "STANDARD", "STANDARD_ON_ORION"}, + map[string]jsonschema.EnumValueMetadata{ + "STORAGE_OPTIMIZED": {LaunchStage: "PUBLIC_PREVIEW"}, + "STANDARD_ON_ORION": {LaunchStage: "DEVELOPMENT"}, + }, + ) + assert.Equal(t, []any{"STORAGE_OPTIMIZED", "STANDARD"}, got) + }) + + t.Run("no metadata is a passthrough", func(t *testing.T) { + enum := []any{"A", "B"} + assert.Equal(t, enum, filterDevelopmentEnumValues(enum, nil)) + }) + + t.Run("all-DEVELOPMENT collapses to nil", func(t *testing.T) { + got := filterDevelopmentEnumValues( + []any{"DEV_ONLY"}, + map[string]jsonschema.EnumValueMetadata{ + "DEV_ONLY": {LaunchStage: "DEVELOPMENT"}, + }, + ) + assert.Nil(t, got) }) } diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index bf42ac27a06..766daa254ca 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -146,7 +146,9 @@ func normalizeLaunchStage(launchStage string) string { // extractEnumLaunchStages pulls per-enum-value launch stages out of an // OpenAPI spec's x-databricks-enum-metadata block, dropping GA/unspecified -// values. Returns nil when nothing remains so the descriptor stays clean. +// values and DEVELOPMENT-stage values (the value name itself shouldn't leak +// into the public annotations file). Returns nil when nothing remains so the +// descriptor stays clean. func extractEnumLaunchStages(metadata map[string]jsonschema.EnumValueMetadata) map[string]string { if len(metadata) == 0 { return nil @@ -154,7 +156,7 @@ func extractEnumLaunchStages(metadata map[string]jsonschema.EnumValueMetadata) m result := map[string]string{} for value, meta := range metadata { ls := normalizeLaunchStage(meta.LaunchStage) - if ls == "" { + if ls == "" || ls == "DEVELOPMENT" { continue } result[value] = ls @@ -166,9 +168,11 @@ func extractEnumLaunchStages(metadata map[string]jsonschema.EnumValueMetadata) m } // extractEnumDescriptions pulls per-enum-value textual descriptions from an -// OpenAPI spec's x-databricks-enum-descriptions block. Returns nil when -// nothing remains so the descriptor stays clean. -func extractEnumDescriptions(descriptions map[string]string) map[string]string { +// OpenAPI spec's x-databricks-enum-descriptions block, dropping entries for +// DEVELOPMENT-stage values (which are themselves filtered out of the enum +// array by filterDevelopmentEnumValues). Returns nil when nothing remains so +// the descriptor stays clean. +func extractEnumDescriptions(descriptions map[string]string, metadata map[string]jsonschema.EnumValueMetadata) map[string]string { if len(descriptions) == 0 { return nil } @@ -177,6 +181,9 @@ func extractEnumDescriptions(descriptions map[string]string) map[string]string { if desc == "" { continue } + if meta, exists := metadata[value]; exists && normalizeLaunchStage(meta.LaunchStage) == "DEVELOPMENT" { + continue + } result[value] = desc } if len(result) == 0 { @@ -185,6 +192,30 @@ func extractEnumDescriptions(descriptions map[string]string) map[string]string { return result } +// filterDevelopmentEnumValues drops any enum value whose +// x-databricks-enum-metadata marks it DEVELOPMENT. Genkit filters these from +// the SDK so they never get a generated Go constant; this keeps them out of +// the bundle schema for the same reason. Returns nil for an empty result so +// JSON serialization omits the field instead of emitting `"enum": []`. +func filterDevelopmentEnumValues(enum []any, metadata map[string]jsonschema.EnumValueMetadata) []any { + if len(enum) == 0 || len(metadata) == 0 { + return enum + } + filtered := make([]any, 0, len(enum)) + for _, v := range enum { + if str, ok := v.(string); ok { + if meta, exists := metadata[str]; exists && normalizeLaunchStage(meta.LaunchStage) == "DEVELOPMENT" { + continue + } + } + filtered = append(filtered, v) + } + if len(filtered) == 0 { + return nil + } + return filtered +} + // Use the OpenAPI spec to load descriptions for the given type. func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overridesPath string) error { annotations := annotation.File{} @@ -218,8 +249,9 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid annotations[basePath] = pkg preview := normalizePreview(ref.Preview) launchStage := normalizeLaunchStage(ref.LaunchStage) + enumValues := filterDevelopmentEnumValues(ref.Enum, ref.EnumMetadata) enumLaunchStages := extractEnumLaunchStages(ref.EnumMetadata) - enumDescriptions := extractEnumDescriptions(ref.EnumDescriptionMap) + enumDescriptions := extractEnumDescriptions(ref.EnumDescriptionMap, ref.EnumMetadata) outputOnly := isOutputOnly(ref) // Skip extraction for DEVELOPMENT-stage types so their descriptions // don't leak into the public annotations file. Genkit drops these @@ -227,14 +259,14 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid if launchStage == "DEVELOPMENT" { return s } - if ref.Description != "" || ref.Enum != nil || ref.Deprecated || ref.DeprecationMessage != "" || preview != "" || launchStage != "" || enumLaunchStages != nil || enumDescriptions != nil || outputOnly != nil { + if ref.Description != "" || enumValues != nil || ref.Deprecated || ref.DeprecationMessage != "" || preview != "" || launchStage != "" || enumLaunchStages != nil || enumDescriptions != nil || outputOnly != nil { if ref.Deprecated && ref.DeprecationMessage == "" { ref.DeprecationMessage = "This field is deprecated" } pkg[RootTypeKey] = annotation.Descriptor{ Description: ref.Description, - Enum: ref.Enum, + Enum: enumValues, DeprecationMessage: ref.DeprecationMessage, Preview: preview, LaunchStage: launchStage, @@ -274,11 +306,11 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid pkg[k] = annotation.Descriptor{ Description: description, - Enum: refProp.Enum, + Enum: filterDevelopmentEnumValues(refProp.Enum, refProp.EnumMetadata), Preview: preview, LaunchStage: launchStage, EnumLaunchStages: extractEnumLaunchStages(refProp.EnumMetadata), - EnumDescriptions: extractEnumDescriptions(refProp.EnumDescriptionMap), + EnumDescriptions: extractEnumDescriptions(refProp.EnumDescriptionMap, refProp.EnumMetadata), DeprecationMessage: refProp.DeprecationMessage, OutputOnly: isOutputOnly(*refProp), } diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 414e70fedd2..71a6770c744 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -80,16 +80,24 @@ "type": "object", "properties": { "custom_description": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "custom_summary": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "display_name": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "evaluation": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation" + "description": "[Public Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "file_path": { "$ref": "#/$defs/string" @@ -98,27 +106,39 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "parent_path": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "permissions": { "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" }, "query_text": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "run_as": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs" + "description": "[Public Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "run_as_user_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "deprecated": true }, "schedule": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule" + "description": "[Public Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.CronSchedule", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "warehouse_id": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -142,7 +162,9 @@ "type": "object", "properties": { "budget_policy_id": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "compute_size": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/apps.ComputeSize" @@ -181,19 +203,26 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "telemetry_export_destinations": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination" + "description": "[Public Preview]", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "usage_policy_id": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "user_api_scopes": { - "$ref": "#/$defs/slice/string" + "description": "[Public Preview]", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -598,23 +627,28 @@ "type": "object", "properties": { "create_database_if_not_exists": { - "$ref": "#/$defs/bool" + "description": "[Public Preview]", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "database_instance_name": { - "description": "The name of the DatabaseInstance housing the database.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The name of the DatabaseInstance housing the database.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "database_name": { - "description": "The name of the database (in a instance) associated with the catalog.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The name of the database (in a instance) associated with the catalog.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "lifecycle": { "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { - "description": "The name of the catalog in UC.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The name of the catalog in UC.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -637,51 +671,61 @@ "description": "A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.", "properties": { "capacity": { - "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", - "$ref": "#/$defs/string" + "description": "[Public Preview] The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\".", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "custom_tags": { - "description": "Custom tags associated with the instance. This field is only included on create and update responses.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.CustomTag" + "description": "[Public Beta] Custom tags associated with the instance. This field is only included on create and update responses.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.CustomTag", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "enable_pg_native_login": { - "description": "Whether to enable PG native password login on the instance. Defaults to false.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Whether to enable PG native password login on the instance. Defaults to false.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "enable_readable_secondaries": { - "description": "Whether to enable secondaries to serve read-only traffic. Defaults to false.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Whether to enable secondaries to serve read-only traffic. Defaults to false.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "lifecycle": { "description": "Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.", "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "name": { - "description": "The name of the instance. This is the unique identifier for the instance.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The name of the instance. This is the unique identifier for the instance.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "node_count": { - "description": "The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see effective_node_count for the output.", - "$ref": "#/$defs/int" + "description": "[Public Preview] The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see effective_node_count for the output.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "parent_instance_ref": { - "description": "The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef" + "description": "[Public Preview] The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.DatabaseInstanceRef", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", - "$ref": "#/$defs/int" + "description": "[Public Preview] The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "stopped": { - "description": "Whether to stop the instance. An input only param, see effective_stopped for the output.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Whether to stop the instance. An input only param, see effective_stopped for the output.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "usage_policy_id": { - "description": "The desired usage policy to associate with the instance.", - "$ref": "#/$defs/string" + "description": "[Public Beta] The desired usage policy to associate with the instance.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -756,8 +800,9 @@ "type": "object", "properties": { "budget_policy_id": { - "description": "The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", @@ -841,9 +886,10 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "webhook_notifications": { @@ -1195,8 +1241,9 @@ "$ref": "#/$defs/bool" }, "budget_policy_id": { - "description": "Budget policy of this pipeline.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Budget policy of this pipeline.", + "$ref": "#/$defs/string", + "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.", @@ -1227,8 +1274,9 @@ "$ref": "#/$defs/string" }, "environment": { - "description": "Environment specification for this pipeline used to install dependencies.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment" + "description": "[Public Preview] Environment specification for this pipeline used to install dependencies.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "event_log": { "description": "Event log configuration for this pipeline", @@ -1239,9 +1287,10 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "id": { @@ -1249,8 +1298,9 @@ "$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.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition" + "description": "[Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "libraries": { "description": "Libraries or code needed by this deployment.", @@ -1276,14 +1326,16 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "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.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "run_as": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RunAs" @@ -1317,9 +1369,10 @@ "deprecated": true }, "usage_policy_id": { - "description": "Usage policy of this pipeline.", + "description": "[Private Preview] Usage policy of this pipeline.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -1618,9 +1671,10 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "inference_log": { @@ -1993,19 +2047,27 @@ "type": "object", "properties": { "database_instance_name": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "lifecycle": { "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" }, "logical_database_name": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "name": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "spec": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec" + "description": "[Public Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -2025,7 +2087,9 @@ "type": "object", "properties": { "budget_policy_id": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "endpoint_type": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/vectorsearch.EndpointType" @@ -2040,11 +2104,15 @@ "$ref": "#/$defs/slice/github.com/databricks/cli/bundle/config/resources.Permission" }, "target_qps": { - "$ref": "#/$defs/int64" + "description": "[Public Preview]", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "usage_policy_id": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -3538,8 +3606,7 @@ "type": "string", "enum": [ "MEDIUM", - "LARGE", - "LIQUID" + "LARGE" ] }, { @@ -3929,8 +3996,10 @@ "description": "Data classification related configuration.", "properties": { "enabled": { - "description": "Whether to enable data classification.", - "$ref": "#/$defs/bool" + "description": "[Private Preview] Whether to enable data classification.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -4092,9 +4161,10 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -4200,19 +4270,7 @@ "CREATE_CLEAN_ROOM", "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", - "EXTERNAL_USE_SCHEMA", - "VIEW_OBJECT", - "MANAGE_GRANTS", - "INSERT", - "UPDATE", - "DELETE", - "VIEW_ADMIN_METADATA", - "VIEW_METADATA", - "USE_VOLUME", - "READ_METADATA", - "MANAGE_ACCESS", - "MANAGE_ACCESS_CONTROL", - "CREATE_SERVICE" + "EXTERNAL_USE_SCHEMA" ] }, { @@ -4712,6 +4770,10 @@ "enum": [ "CONFIDENTIAL_COMPUTE_TYPE_NONE", "SEV_SNP" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, { @@ -4724,7 +4786,7 @@ "oneOf": [ { "type": "string", - "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\nThe following modes can only be used when `kind = CLASSIC_PREVIEW`.\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\n\nThe following modes can be used regardless of `kind`.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n* `SINGLE_USER`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `USER_ISOLATION`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", "enum": [ "NONE", "SINGLE_USER", @@ -4736,6 +4798,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." ] }, { @@ -4832,7 +4906,7 @@ "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip and java dependencies are supported.", "properties": { "base_environment": { - "description": "The base environment this environment is built on top of. A base environment defines the environment version and a\nlist of dependencies for serverless compute. The value can be a file path to a custom `env.yaml` file\n(e.g., `/Workspace/path/to/env.yaml`). Support for a Databricks-provided base environment ID\n(e.g., `workspace-base-environments/databricks_ai_v4`) and workspace base environment ID\n(e.g., `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) is in Beta.\nEither `environment_version` or `base_environment` can be provided. For more information, see", + "description": "The base environment this environment is built on top of. A base environment defines the environment version and a\nlist of dependencies for serverless compute. The value can be a file path to a custom `env.yaml` file\n(e.g., `/Workspace/path/to/env.yaml`). Support for a Databricks-provided base environment ID\n(e.g., `workspace-base-environments/databricks_ai_v4`) and workspace base environment ID\n(e.g., `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) is in Beta.\nEither `environment_version` or `base_environment` can be provided.\nFor more information about Databricks-provided base environments, see the\n[list workspace base environments](:method:Environments/ListWorkspaceBaseEnvironments) API.\nFor more information, see", "$ref": "#/$defs/string" }, "client": { @@ -4850,7 +4924,9 @@ "$ref": "#/$defs/string" }, "java_dependencies": { - "$ref": "#/$defs/slice/string" + "description": "[Public Preview]", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -4875,9 +4951,10 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "first_on_demand": { @@ -4957,8 +5034,11 @@ "description": "HardwareAcceleratorType: The type of hardware accelerator to use for compute workloads.\nNOTE: This enum is referenced and is intended to be used by other Databricks services\nthat need to specify hardware accelerator requirements for AI compute workloads.", "enum": [ "GPU_1xA10", - "GPU_8xH100", - "GPU_1xH100" + "GPU_8xH100" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, { @@ -5360,12 +5440,14 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The key of the custom tag.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "value": { - "description": "The value of the custom tag.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The value of the custom tag.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -5383,16 +5465,19 @@ "description": "DatabaseInstanceRef is a reference to a database instance. It is used in the\nDatabaseInstance object to refer to the parent instance of an instance and\nto refer the child instances of an instance.\nTo specify as a parent instance during creation of an instance,\nthe lsn and branch_time fields are optional. If not specified, the child\ninstance will be created from the latest lsn of the parent.\nIf both lsn and branch_time are specified, the lsn will be used to create\nthe child instance.", "properties": { "branch_time": { - "description": "Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "lsn": { - "description": "User-specified WAL LSN of the ref database instance.\n\nInput: For specifying the WAL LSN to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", - "$ref": "#/$defs/string" + "description": "[Public Preview] User-specified WAL LSN of the ref database instance.\n\nInput: For specifying the WAL LSN to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "name": { - "description": "Name of the ref database instance.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Name of the ref database instance.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -5413,8 +5498,15 @@ "DELETING", "STOPPED", "UPDATING", - "FAILING_OVER", - "MIGRATING" + "FAILING_OVER" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -5442,16 +5534,19 @@ "description": "Custom fields that user can set for pipeline while creating SyncedDatabaseTable.\nNote that other fields of pipeline are still inferred by table def internally", "properties": { "budget_policy_id": { - "description": "Budget policy to set on the newly created pipeline.", - "$ref": "#/$defs/string" + "description": "[Public Beta] Budget policy to set on the newly created pipeline.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "storage_catalog": { - "description": "This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", - "$ref": "#/$defs/string" + "description": "[Public Preview] This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "storage_schema": { - "description": "This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", - "$ref": "#/$defs/string" + "description": "[Public Preview] This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -5473,6 +5568,14 @@ "DELETING", "UPDATING", "DEGRADED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -5489,6 +5592,11 @@ "PROVISIONING_PHASE_MAIN", "PROVISIONING_PHASE_INDEX_SCAN", "PROVISIONING_PHASE_INDEX_SORT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -5569,6 +5677,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -5584,32 +5697,39 @@ "description": "Specification of a synced database table.", "properties": { "create_database_objects_if_missing": { - "description": "If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "existing_pipeline_id": { - "description": "At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline\nreferenced. This avoids creating a new pipeline and allows sharing existing compute.\nIn this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline.", - "$ref": "#/$defs/string" + "description": "[Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline\nreferenced. This avoids creating a new pipeline and allows sharing existing compute.\nIn this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "new_pipeline_spec": { - "description": "At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used\nto store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta\ntables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table\nonly requires read permissions.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec" + "description": "[Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined.\n\nIf new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used\nto store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta\ntables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table\nonly requires read permissions.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "primary_key_columns": { - "description": "Primary Key columns to be used for data insert/update in the destination.", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] Primary Key columns to be used for data insert/update in the destination.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "scheduling_policy": { - "description": "Scheduling policy of the underlying pipeline.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPolicy" + "description": "[Public Preview] Scheduling policy of the underlying pipeline.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSchedulingPolicy", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_table_full_name": { - "description": "Three-part (catalog, schema, table) name of the source Delta table.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Three-part (catalog, schema, table) name of the source Delta table.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "timeseries_key": { - "description": "Time series key to deduplicate (tie-break) rows with the same primary key.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Time series key to deduplicate (tie-break) rows with the same primary key.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -5637,6 +5757,19 @@ "SYNCED_TABLE_OFFLINE_FAILED", "SYNCED_TABLE_ONLINE_PIPELINE_FAILED", "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -5652,20 +5785,24 @@ "description": "Status of a synced table.", "properties": { "continuous_update_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE\nor the SYNCED_UPDATING_PIPELINE_RESOURCES state.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus" + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the SYNCED_CONTINUOUS_UPDATE\nor the SYNCED_UPDATING_PIPELINE_RESOURCES state.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableContinuousUpdateStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "failed_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus" + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the OFFLINE_FAILED or the\nSYNCED_PIPELINE_FAILED state.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableFailedStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "provisioning_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioningStatus" + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the\nPROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableProvisioningStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "triggered_update_status": { - "description": "Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE\nor the SYNCED_NO_PENDING_UPDATE state.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpdateStatus" + "description": "[Public Preview] Detailed status of a synced table. Shown if the synced table is in the SYNCED_TRIGGERED_UPDATE\nor the SYNCED_NO_PENDING_UPDATE state.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableTriggeredUpdateStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -5714,8 +5851,29 @@ "CAN_MONITOR", "CAN_CREATE", "CAN_MONITOR_ONLY", - "CAN_CREATE_APP", - "UNSPECIFIED" + "CAN_CREATE_APP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "[PrPr]", + "[PrPr]" ] }, { @@ -5730,20 +5888,24 @@ "type": "object", "properties": { "alert_id": { - "description": "The alert_id is the canonical identifier of the alert.", - "$ref": "#/$defs/string" + "description": "[Public Beta] The alert_id is the canonical identifier of the alert.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "subscribers": { - "description": "The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber" + "description": "[Public Beta] The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "warehouse_id": { - "description": "The warehouse_id identifies the warehouse settings used by the alert task.", - "$ref": "#/$defs/string" + "description": "[Public Beta] The warehouse_id identifies the warehouse settings used by the alert task.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "workspace_path": { - "description": "The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", - "$ref": "#/$defs/string" + "description": "[Public Beta] The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -5761,11 +5923,14 @@ "description": "Represents a subscriber that will receive alert notifications.\nA subscriber can be either a user (via email) or a notification destination (via destination_id).", "properties": { "destination_id": { - "$ref": "#/$defs/string" + "description": "[Public Beta]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "user_name": { - "description": "A valid workspace email address.", - "$ref": "#/$defs/string" + "description": "[Public Beta] A valid workspace email address.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -5783,6 +5948,10 @@ "enum": [ "OAUTH", "PAT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, { @@ -5832,8 +6001,9 @@ "type": "object", "properties": { "hardware_accelerator": { - "description": "Hardware accelerator configuration for Serverless GPU workloads.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType" + "description": "[Public Beta] Hardware accelerator configuration for Serverless GPU workloads.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -5850,16 +6020,22 @@ "type": "object", "properties": { "gpu_node_pool_id": { - "description": "IDof the GPU pool to use.", - "$ref": "#/$defs/string" + "description": "[Private Preview] IDof the GPU pool to use.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "gpu_type": { - "description": "GPU type.", - "$ref": "#/$defs/string" + "description": "[Private Preview] GPU type.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "num_gpus": { - "description": "Number of GPUs.", - "$ref": "#/$defs/int" + "description": "[Private Preview] Number of GPUs.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false, @@ -6001,9 +6177,10 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "subscription": { @@ -6029,12 +6206,16 @@ "description": "Deprecated in favor of DbtPlatformTask", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt Cloud for this task", - "$ref": "#/$defs/string" + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt Cloud for this task", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "dbt_cloud_job_id": { - "description": "Id of the dbt Cloud job to be triggered", - "$ref": "#/$defs/int64" + "description": "[Private Preview] Id of the dbt Cloud job to be triggered", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -6051,12 +6232,16 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt platform for this task", - "$ref": "#/$defs/string" + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "dbt_platform_job_id": { - "description": "Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -6192,35 +6377,52 @@ "type": "object", "properties": { "command": { - "description": "Command launcher to run the actual script, e.g. bash, python etc.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Command launcher to run the actual script, e.g. bash, python etc.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "compute": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig" + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "dl_runtime_image": { - "description": "Runtime image", - "$ref": "#/$defs/string" + "description": "[Private Preview] Runtime image", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "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.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "source": { - "description": "Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source" + "description": "[Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "training_script_path": { - "description": "The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", - "$ref": "#/$defs/string" + "description": "[Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "yaml_parameters": { - "description": "Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "yaml_parameters_file_path": { - "description": "Optional path to a YAML file containing model parameters passed to the training script.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Optional path to a YAML file containing model parameters passed to the training script.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false, @@ -6375,6 +6577,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." ] }, { @@ -6391,6 +6597,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." ] }, { @@ -6423,8 +6633,9 @@ "$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.", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", @@ -6536,9 +6747,10 @@ "description": "Write-only setting. Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who created the job.\n\nEither `user_name` or `service_principal_name` should be specified. If not, an error is thrown.", "properties": { "group_name": { - "description": "Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", + "description": "[Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "service_principal_name": { @@ -6565,16 +6777,22 @@ "description": "The source of the job specification in the remote repository when the job is source controlled.", "properties": { "dirty_state": { - "description": "Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState" + "description": "[Private Preview] Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "import_from_git_branch": { - "description": "Name of the branch which the job is imported from.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Name of the branch which the job is imported from.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "job_config_path": { - "description": "Path of the job YAML file that contains the job specification.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Path of the job YAML file that contains the job specification.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false, @@ -6597,6 +6815,10 @@ "enum": [ "NOT_SYNCED", "DISCONNECTED" + ], + "enumDescriptions": [ + "[PrPr] The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.", + "[PrPr] 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." ] }, { @@ -6616,6 +6838,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." ] }, { @@ -6692,24 +6921,34 @@ "type": "object", "properties": { "aliases": { - "description": "Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", - "$ref": "#/$defs/slice/string" + "description": "[Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "condition": { - "description": "The condition based on which to trigger a job run.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition" + "description": "[Private Preview] The condition based on which to trigger a job run.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "min_time_between_triggers_seconds": { - "description": "If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", - "$ref": "#/$defs/int" + "description": "[Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "securable_name": { - "description": "Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "wait_after_last_change_seconds": { - "description": "If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", - "$ref": "#/$defs/int" + "description": "[Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false, @@ -6731,6 +6970,11 @@ "MODEL_CREATED", "MODEL_VERSION_READY", "MODEL_ALIAS_SET" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -6894,24 +7138,29 @@ "type": "object", "properties": { "authentication_method": { - "description": "How the published Power BI model authenticates to Databricks", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod" + "description": "[Public Preview] How the published Power BI model authenticates to Databricks", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "model_name": { - "description": "The name of the Power BI model", - "$ref": "#/$defs/string" + "description": "[Public Preview] The name of the Power BI model", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "overwrite_existing": { - "description": "Whether to overwrite existing Power BI models", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Whether to overwrite existing Power BI models", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "storage_mode": { - "description": "The default storage mode of the Power BI model", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode" + "description": "[Public Preview] The default storage mode of the Power BI model", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "workspace_name": { - "description": "The name of the Power BI workspace of the model", - "$ref": "#/$defs/string" + "description": "[Public Preview] The name of the Power BI workspace of the model", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -6928,20 +7177,24 @@ "type": "object", "properties": { "catalog": { - "description": "The catalog name in Databricks", - "$ref": "#/$defs/string" + "description": "[Public Preview] The catalog name in Databricks", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "name": { - "description": "The table name in Databricks", - "$ref": "#/$defs/string" + "description": "[Public Preview] The table name in Databricks", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "schema": { - "description": "The schema name in Databricks", - "$ref": "#/$defs/string" + "description": "[Public Preview] The schema name in Databricks", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "storage_mode": { - "description": "The Power BI storage mode of the table", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode" + "description": "[Public Preview] The Power BI storage mode of the table", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.StorageMode", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -6958,24 +7211,29 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection to authenticate from Databricks to Power BI", - "$ref": "#/$defs/string" + "description": "[Public Preview] The resource name of the UC connection to authenticate from Databricks to Power BI", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "power_bi_model": { - "description": "The semantic model to update", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiModel" + "description": "[Public Preview] The semantic model to update", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiModel", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "refresh_after_update": { - "description": "Whether the model should be refreshed after the update", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Whether the model should be refreshed after the update", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "tables": { - "description": "The tables to be exported to Power BI", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable" + "description": "[Public Preview] The tables to be exported to Power BI", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTable", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "warehouse_id": { - "description": "The SQL warehouse ID to use as the Power BI data source", - "$ref": "#/$defs/string" + "description": "[Public Preview] The SQL warehouse ID to use as the Power BI data source", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -7053,6 +7311,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" ] }, { @@ -7067,17 +7333,19 @@ "type": "object", "properties": { "dbt_commands": { - "description": "An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true }, "jar_params": { - "description": "A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -7091,9 +7359,10 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -7103,32 +7372,37 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true }, "python_params": { - "description": "A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", + "description": "[Private Preview] A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true }, "spark_submit_params": { - "description": "A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", + "description": "[Private Preview] A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true }, "sql_params": { - "description": "A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true @@ -7153,6 +7427,10 @@ "enum": [ "WORKSPACE", "GIT" + ], + "enumDescriptions": [ + "SQL file is located in \u003cDatabricks\u003e workspace.", + "SQL file is located in cloud Git provider." ] }, { @@ -7439,6 +7717,11 @@ "DIRECT_QUERY", "IMPORT", "DUAL" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -7531,16 +7814,18 @@ "type": "object", "properties": { "alert_task": { - "description": "The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask" + "description": "[Public Beta] The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "clean_rooms_notebook_task": { "description": "The task runs a [clean rooms](https://docs.databricks.com/clean-rooms/index.html) notebook\nwhen the `clean_rooms_notebook_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.CleanRoomsNotebookTask" }, "compute": { - "description": "Task level compute configuration.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute" + "description": "[Public Beta] Task level compute configuration.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "condition_task": { "description": "The task evaluates a condition that can be used to control the execution of other tasks when the `condition_task` field is present.\nThe condition task does not require a cluster to execute and does not support retries or notifications.", @@ -7551,16 +7836,19 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "deprecated": true }, "dbt_platform_task": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "dbt_task": { @@ -7581,9 +7869,7 @@ }, "disabled": { "description": "An optional flag to disable the task. If set to true, the task will not run even if it is part of a job.", - "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true + "$ref": "#/$defs/bool" }, "email_notifications": { "description": "An optional set of email addresses that is notified when runs of this task begin or complete as well as when this task is deleted. The default behavior is to not send any emails.", @@ -7602,8 +7888,10 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "health": { @@ -7642,8 +7930,9 @@ "$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.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask" + "description": "[Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "python_wheel_task": { "description": "The task runs a Python wheel when the `python_wheel_task` field is present.", @@ -7752,8 +8041,9 @@ "$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.", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", @@ -7820,8 +8110,10 @@ "$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", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "pause_status": { @@ -7882,8 +8174,9 @@ "$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.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook" + "description": "[Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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.", @@ -7987,12 +8280,14 @@ "description": "Policy for auto full refresh.", "properties": { "enabled": { - "description": "(Required, Mutable) Whether to enable auto full refresh or not.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] (Required, Mutable) Whether to enable auto full refresh or not.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "min_interval_hours": { - "description": "(Optional, Mutable) Specify the minimum interval in hours between the timestamp\nat which a table was last full refreshed and the current timestamp for triggering auto full\nIf unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours.", - "$ref": "#/$defs/int" + "description": "[Public Preview] (Optional, Mutable) Specify the minimum interval in hours between the timestamp\nat which a table was last full refreshed and the current timestamp for triggering auto full\nIf unspecified and autoFullRefresh is enabled then by default min_interval_hours is 24 hours.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -8013,8 +8308,9 @@ "description": "Confluence specific options for ingestion", "properties": { "include_confluence_spaces": { - "description": "(Optional) Spaces to filter Confluence data on", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] (Optional) Spaces to filter Confluence data on", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -8031,9 +8327,10 @@ "type": "object", "properties": { "source_catalog": { - "description": "Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", + "description": "[Private Preview] Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8052,55 +8349,67 @@ "description": "Wrapper message for source-specific options to support multiple connector types", "properties": { "confluence_options": { - "description": "Confluence specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions" + "description": "[Public Preview] Confluence specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConfluenceConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "gdrive_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "google_ads_options": { - "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", + "description": "[Private Preview] Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "jira_options": { - "description": "Jira specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions" + "description": "[Public Beta] Jira specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "meta_ads_options": { - "description": "Meta Marketing (Meta Ads) specific options for ingestion", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions" + "description": "[Public Beta] Meta Marketing (Meta Ads) specific options for ingestion", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "outlook_options": { - "description": "Outlook specific options for ingestion", + "description": "[Private Preview] Outlook specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "sharepoint_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "smartsheet_options": { - "description": "Smartsheet specific options for ingestion", + "description": "[Private Preview] Smartsheet specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "tiktok_ads_options": { - "description": "TikTok Ads specific options for ingestion", + "description": "[Private Preview] TikTok Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "zendesk_support_options": { - "description": "Zendesk Support specific options for ingestion", + "description": "[Private Preview] Zendesk Support specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -8120,6 +8429,10 @@ "enum": [ "CDC", "QUERY_BASED" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, { @@ -8155,16 +8468,22 @@ "description": "Location of staged data storage", "properties": { "catalog_name": { - "description": "(Required, Immutable) The name of the catalog for the connector's staging storage location.", - "$ref": "#/$defs/string" + "description": "[Private Preview] (Required, Immutable) The name of the catalog for the connector's staging storage location.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "schema_name": { - "description": "(Required, Immutable) The name of the schema for the connector's staging storage location.", - "$ref": "#/$defs/string" + "description": "[Private Preview] (Required, Immutable) The name of the schema for the connector's staging storage location.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "volume_name": { - "description": "(Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", - "$ref": "#/$defs/string" + "description": "[Private Preview] (Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false, @@ -8192,6 +8511,15 @@ "FRIDAY", "SATURDAY", "SUNDAY" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -8248,16 +8576,22 @@ "type": "object", "properties": { "modified_after": { - "description": "Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", - "$ref": "#/$defs/string" + "description": "[Private Preview] Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "modified_before": { - "description": "Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", - "$ref": "#/$defs/string" + "description": "[Private Preview] Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "path_filter": { - "description": "Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", - "$ref": "#/$defs/string" + "description": "[Private Preview] Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -8274,43 +8608,70 @@ "type": "object", "properties": { "corrupt_record_column": { - "$ref": "#/$defs/string" + "description": "[Private Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "file_filters": { - "description": "Generic options", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter" + "description": "[Private Preview] Generic options", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "format": { - "description": "required for TableSpec", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat" + "description": "[Private Preview] required for TableSpec", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "format_options": { - "description": "Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", - "$ref": "#/$defs/map/string" + "description": "[Private Preview] Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "ignore_corrupt_files": { - "$ref": "#/$defs/bool" + "description": "[Private Preview]", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "infer_column_types": { - "$ref": "#/$defs/bool" + "description": "[Private Preview]", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "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", - "$ref": "#/$defs/bool" + "description": "[Private Preview] Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "rescued_data_column": { - "$ref": "#/$defs/string" + "description": "[Private Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "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", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode" + "description": "[Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "schema_hints": { - "description": "Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", - "$ref": "#/$defs/string" + "description": "[Private Preview] Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "single_variant_column": { - "$ref": "#/$defs/string" + "description": "[Private Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -8334,6 +8695,16 @@ "PARQUET", "AVRO", "ORC" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -8353,6 +8724,13 @@ "RESCUE", "FAIL_ON_NEW_COLUMNS", "NONE" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -8407,8 +8785,10 @@ "type": "object", "properties": { "manager_account_id": { - "description": "(Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", - "$ref": "#/$defs/string" + "description": "[Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -8426,16 +8806,22 @@ "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "properties": { "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", - "$ref": "#/$defs/int" + "description": "[Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "manager_account_id": { - "description": "(Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", - "$ref": "#/$defs/string" + "description": "[Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", - "$ref": "#/$defs/string" + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false, @@ -8455,14 +8841,22 @@ "type": "object", "properties": { "entity_type": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType" + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "file_ingestion_options": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions" + "description": "[Private Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "url": { - "description": "Google Drive URL.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Google Drive URL.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -8481,6 +8875,11 @@ "FILE", "FILE_METADATA", "PERMISSION" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -8495,16 +8894,19 @@ "type": "object", "properties": { "report": { - "description": "Select a specific source report.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec" + "description": "[Public Preview] Select a specific source report.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "schema": { - "description": "Select all tables from a specific source schema.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec" + "description": "[Public Preview] Select all tables from a specific source schema.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SchemaSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "table": { - "description": "Select a specific source table.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec" + "description": "[Public Preview] Select a specific source table.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -8521,32 +8923,43 @@ "type": "object", "properties": { "connection_id": { - "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "description": "[Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "deprecated": true }, "connection_name": { - "description": "Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "connection_parameters": { - "description": "Optional, Internal. Parameters required to establish an initial connection with the source.", + "description": "[Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "gateway_storage_catalog": { - "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "gateway_storage_name": { - "description": "Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "gateway_storage_schema": { - "description": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false, @@ -8568,49 +8981,60 @@ "type": "object", "properties": { "connection_name": { - "description": "The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with\nboth connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle,\n(connector_type = QUERY_BASED OR connector_type = CDC).\nIf connection name corresponds to database connectors like Oracle, and connector_type is not provided then\nconnector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion\npipeline.\nUnder certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed\nIngestion Pipeline with Gateway pipeline.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The Unity Catalog connection that this ingestion pipeline uses to communicate with the source. This is used with\nboth connectors for applications like Salesforce, Workday, and so on, and also database connectors like Oracle,\n(connector_type = QUERY_BASED OR connector_type = CDC).\nIf connection name corresponds to database connectors like Oracle, and connector_type is not provided then\nconnector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion\npipeline.\nUnder certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed\nIngestion Pipeline with Gateway pipeline.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "connector_type": { - "description": "(Optional) Connector Type for sources. Ex: CDC, Query Based.", + "description": "[Private Preview] (Optional) Connector Type for sources. Ex: CDC, Query Based.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "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": "[Private Preview] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "full_refresh_window": { - "description": "(Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow" + "description": "[Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "ingest_from_uc_foreign_catalog": { - "description": "Immutable. If set to true, the pipeline will ingest tables from the\nUC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.\nThe `source_catalog` fields in objects of IngestionConfig are interpreted as\nthe UC foreign catalogs to ingest from.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Immutable. If set to true, the pipeline will ingest tables from the\nUC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.\nThe `source_catalog` fields in objects of IngestionConfig are interpreted as\nthe UC foreign catalogs to ingest from.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "ingestion_gateway_id": { - "description": "Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database.\nThis is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC).\nUnder certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc\nManaged Ingestion Pipeline.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database.\nThis is used with CDC connectors to databases like SQL Server using a gateway pipeline (connector_type = CDC).\nUnder certain conditions, this can be replaced with connection_name to change the connector to Combined Cdc\nManaged Ingestion Pipeline.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "netsuite_jar_path": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "objects": { - "description": "Required. Settings specifying tables to replicate and the destination for the replicated tables.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig" + "description": "[Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_configurations": { - "description": "Top-level source configurations", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig" + "description": "[Public Preview] Top-level source configurations", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "table_configuration": { - "description": "Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig" + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -8628,16 +9052,19 @@ "description": "Configurations that are only applicable for query-based ingestion connectors.", "properties": { "cursor_columns": { - "description": "The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "deletion_condition": { - "description": "Specifies a SQL WHERE condition that specifies that the source row has been deleted.\nThis is sometimes referred to as \"soft-deletes\".\nFor example: \"Operation = 'DELETE'\" or \"is_deleted = true\".\nThis field is orthogonal to `hard_deletion_sync_interval_in_seconds`,\none for soft-deletes and the other for hard-deletes.\nSee also the hard_deletion_sync_min_interval_in_seconds field for\nhandling of \"hard deletes\" where the source rows are physically removed from the table.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted.\nThis is sometimes referred to as \"soft-deletes\".\nFor example: \"Operation = 'DELETE'\" or \"is_deleted = true\".\nThis field is orthogonal to `hard_deletion_sync_interval_in_seconds`,\none for soft-deletes and the other for hard-deletes.\nSee also the hard_deletion_sync_min_interval_in_seconds field for\nhandling of \"hard deletes\" where the source rows are physically removed from the table.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "hard_deletion_sync_min_interval_in_seconds": { - "description": "Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", - "$ref": "#/$defs/int64" + "description": "[Public Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -8654,19 +9081,25 @@ "type": "object", "properties": { "incremental": { - "description": "(Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", + "description": "[Private Preview] (Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "deprecated": true }, "parameters": { - "description": "Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", - "$ref": "#/$defs/map/string" + "description": "[Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "report_parameters": { - "description": "(Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", + "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "deprecated": true } }, @@ -8684,12 +9117,16 @@ "type": "object", "properties": { "key": { - "description": "Key for the report parameter, can be a column name or other metadata", - "$ref": "#/$defs/string" + "description": "[Private Preview] Key for the report parameter, can be a column name or other metadata", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "value": { - "description": "Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", - "$ref": "#/$defs/string" + "description": "[Private Preview] Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -8707,8 +9144,6 @@ "enum": [ "MYSQL", "POSTGRESQL", - "REDSHIFT", - "SQLDW", "SQLSERVER", "SALESFORCE", "BIGQUERY", @@ -8725,87 +9160,30 @@ "JIRA", "CONFLUENCE", "META_MARKETING", - "GOOGLE_ADS", - "TIKTOK_ADS", - "SALESFORCE_MARKETING_CLOUD", - "HUBSPOT", - "WORKDAY_HCM", - "GUIDEWIRE", "ZENDESK", - "COMMUNITY", - "SLACK_AUDIT_LOGS", - "KAFKA", - "CROWDSTRIKE_EVENT_STREAM", - "WORKDAY_ACTIVITY_LOGGING", - "AKAMAI_WAF", - "VEEVA", - "VEEVA_VAULT", - "M365_AUDIT_LOGS", - "OKTA_SYSTEM_LOGS", - "ONE_PASSWORD_EVENT_LOGS", - "PROOFPOINT_SIEM", - "WIZ_AUDIT_LOGS", - "GITHUB", - "OUTLOOK", - "SMARTSHEET", - "MICROSOFT_TEAMS", - "ADOBE_CAMPAIGNS", - "LINKEDIN_ADS", - "X_ADS", - "BING_ADS", - "GOOGLE_SEARCH_CONSOLE", - "PINTEREST_ADS", - "REDDIT_ADS", - "PENDO", - "API_SOURCE", - "SLACK_ACCESS_AND_INTEGRATION_LOGS", - "ORACLE_FUSION_CLOUD", - "RABBITMQ", - "GOOGLE_ANALYTICS", - "AMPLITUDE", - "NOTION", - "ADP_WORKFORCE_NOW", - "SAS", - "GONG", - "SALESLOFT", - "GOOGLE_WORKSPACE", - "SHOPIFY", - "ORACLE_ELOQUA", - "EPIC_CLARITY", - "LINEAR", - "APPLE_APP_STORE", - "SPLUNK", - "GITLAB", - "ZOOM_LOGS", - "MONDAY_COM", - "AIRTABLE", - "MICROSOFT_ENTRA_ID", - "PAGERDUTY", - "APPFIGURES", - "ADOBE_COMMERCE", - "QUICKBOOKS", - "SQUARE", - "ZOHO_BOOKS", - "SNAPCHAT_ADS", - "GENESYS", - "SAP_SUCCESSFACTORS", - "YOUTUBE_ANALYTICS", - "CERIDIAN_DAYFORCE", - "FRESHSERVICE", - "SENDGRID", - "AZURE_MONITOR_LOGS", - "ATLASSIAN_ORGANIZATION", - "HIBOB", - "APPLE_SEARCH_ADS", - "AWIN", - "DELIGHTED", - "FRONT", - "GURU", - "PARTNERSTACK", - "MARKETO", - "AHA", - "NETSKOPE_LOGS", "FOREIGN_CATALOG" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PrPr]", + "[Beta]", + "[PuPr]", + "[Beta]", + "[PrPr]", + "[PrPr]" ] }, { @@ -8821,8 +9199,9 @@ "description": "Jira specific options for ingestion", "properties": { "include_jira_spaces": { - "description": "(Optional) Projects to filter Jira data on", - "$ref": "#/$defs/slice/string" + "description": "[Public Beta] (Optional) Projects to filter Jira data on", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -8852,36 +9231,44 @@ "description": "Meta Marketing (Meta Ads) specific options for ingestion", "properties": { "action_attribution_windows": { - "description": "(Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", - "$ref": "#/$defs/slice/string" + "description": "[Public Beta] (Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "action_breakdowns": { - "description": "(Optional) Action breakdowns to configure for data aggregation", - "$ref": "#/$defs/slice/string" + "description": "[Public Beta] (Optional) Action breakdowns to configure for data aggregation", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "action_report_time": { - "description": "(Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", - "$ref": "#/$defs/string" + "description": "[Public Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "breakdowns": { - "description": "(Optional) Breakdowns to configure for data aggregation", - "$ref": "#/$defs/slice/string" + "description": "[Public Beta] (Optional) Breakdowns to configure for data aggregation", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "custom_insights_lookback_window": { - "description": "(Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", - "$ref": "#/$defs/int" + "description": "[Public Beta] (Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "level": { - "description": "(Optional) Granularity of data to pull (account, ad, adset, campaign)", - "$ref": "#/$defs/string" + "description": "[Public Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign)", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "start_date": { - "description": "(Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added\nafter this date will be ingested", - "$ref": "#/$defs/string" + "description": "[Public 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-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)", - "$ref": "#/$defs/string" + "description": "[Public Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -8939,16 +9326,19 @@ "description": "Proto representing a window", "properties": { "days_of_week": { - "description": "Days of week in which the window is allowed to happen\nIf not specified all days of the week will be used.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek" + "description": "[Public Preview] Days of week in which the window is allowed to happen\nIf not specified all days of the week will be used.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "start_hour": { - "description": "An integer between 0 and 23 denoting the start hour for the window in the 24-hour day.", - "$ref": "#/$defs/int" + "description": "[Public Preview] An integer between 0 and 23 denoting the start hour for the window in the 24-hour day.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "time_zone_id": { - "description": "Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Time zone id of window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -8972,6 +9362,12 @@ "NON_INLINE_ONLY", "INLINE_ONLY", "NONE" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -8988,6 +9384,10 @@ "enum": [ "TEXT_HTML", "TEXT_PLAIN" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, { @@ -9003,49 +9403,69 @@ "description": "Outlook specific options for ingestion", "properties": { "attachment_mode": { - "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode" + "description": "[Private Preview] (Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "body_format": { - "description": "(Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat" + "description": "[Private Preview] (Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "folder_filter": { - "description": "Deprecated. Use include_folders instead.", + "description": "[Private Preview] Deprecated. Use include_folders instead.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "deprecated": true }, "include_folders": { - "description": "(Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", - "$ref": "#/$defs/slice/string" + "description": "[Private Preview] (Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "include_mailboxes": { - "description": "(Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", - "$ref": "#/$defs/slice/string" + "description": "[Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "include_senders": { - "description": "(Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", - "$ref": "#/$defs/slice/string" + "description": "[Private Preview] (Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "include_subjects": { - "description": "(Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", - "$ref": "#/$defs/slice/string" + "description": "[Private Preview] (Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "sender_filter": { - "description": "Deprecated. Use include_senders instead.", + "description": "[Private Preview] Deprecated. Use include_senders instead.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "deprecated": true }, "start_date": { - "description": "(Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", - "$ref": "#/$defs/string" + "description": "[Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "subject_filter": { - "description": "Deprecated. Use include_subjects instead.", + "description": "[Private Preview] Deprecated. Use include_subjects instead.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "deprecated": true } }, @@ -9063,8 +9483,9 @@ "type": "object", "properties": { "include": { - "description": "The source code to include for pipelines", - "$ref": "#/$defs/string" + "description": "[Public Preview] The source code to include for pipelines", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -9246,19 +9667,22 @@ "$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`.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern" + "description": "[Public Preview] The unified field to include source codes.\nEach entry can be a notebook path, a file path, or a folder path that ends `/**`.\nThis field cannot be used together with `notebook` or `file`.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "jar": { - "description": "URI of the jar to be installed. Currently only DBFS is supported.", + "description": "[Private Preview] URI of the jar to be installed. Currently only DBFS is supported.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "maven": { - "description": "Specification of a maven library to be installed.", + "description": "[Private Preview] Specification of a maven library to be installed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "notebook": { @@ -9325,13 +9749,15 @@ "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", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] List of pip dependencies, as supported by the version of pip in this environment.\nEach dependency is a pip requirement file line https://pip.pypa.io/en/stable/reference/requirements-file-format/\nAllowed dependency could be \u003crequirement specifier\u003e, \u003carchive url/path\u003e, \u003clocal project path\u003e(WSFS or Volumes in Databricks), \u003cvcs project url\u003e", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "environment_version": { - "description": "The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", + "description": "[Private Preview] The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9350,8 +9776,9 @@ "description": "PG-specific catalog-level configuration parameters", "properties": { "slot_config": { - "description": "Optional. The Postgres slot configuration to use for logical replication", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig" + "description": "[Public Preview] Optional. The Postgres slot configuration to use for logical replication", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -9369,12 +9796,14 @@ "description": "PostgresSlotConfig contains the configuration for a Postgres logical replication slot", "properties": { "publication_name": { - "description": "The name of the publication to use for the Postgres source", - "$ref": "#/$defs/string" + "description": "[Public Preview] The name of the publication to use for the Postgres source", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "slot_name": { - "description": "The name of the logical replication slot to use for the Postgres source", - "$ref": "#/$defs/string" + "description": "[Public Preview] The name of the logical replication slot to use for the Postgres source", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -9391,24 +9820,29 @@ "type": "object", "properties": { "destination_catalog": { - "description": "Required. Destination catalog to store table.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Destination catalog to store table.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_schema": { - "description": "Required. Destination schema to store table.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Destination schema to store table.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_table": { - "description": "Required. Destination table name. The pipeline fails if a table with that name already exists.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Destination table name. The pipeline fails if a table with that name already exists.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_url": { - "description": "Required. Report URL in the source system.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Report URL in the source system.", + "$ref": "#/$defs/string", + "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.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig" + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -9430,16 +9864,22 @@ "type": "object", "properties": { "days_of_week": { - "description": "Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek" + "description": "[Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "start_hour": { - "description": "An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", - "$ref": "#/$defs/int" + "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "time_zone_id": { - "description": "Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false, @@ -9482,28 +9922,34 @@ "type": "object", "properties": { "connector_options": { - "description": "(Optional) Source Specific Connector Options", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions" + "description": "[Public Preview] (Optional) Source Specific Connector Options", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_catalog": { - "description": "Required. Destination catalog to store tables.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Destination catalog to store tables.", + "$ref": "#/$defs/string", + "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.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_catalog": { - "description": "The source catalog name. Might be optional depending on the type of source.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The source catalog name. Might be optional depending on the type of source.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_schema": { - "description": "Required. Schema name in the source database.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Schema name in the source database.", + "$ref": "#/$defs/string", + "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.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig" + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -9525,16 +9971,22 @@ "type": "object", "properties": { "entity_type": { - "description": "(Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType" + "description": "[Private Preview] (Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "file_ingestion_options": { - "description": "(Optional) File ingestion options for processing files.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions" + "description": "[Private Preview] (Optional) File ingestion options for processing files.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "url": { - "description": "Required. The SharePoint URL.", - "$ref": "#/$defs/string" + "description": "[Private Preview] Required. The SharePoint URL.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -9554,6 +10006,12 @@ "FILE_METADATA", "PERMISSION", "LIST" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -9569,8 +10027,10 @@ "description": "Smartsheet specific options for ingestion", "properties": { "enforce_schema": { - "description": "(Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", - "$ref": "#/$defs/bool" + "description": "[Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -9588,12 +10048,14 @@ "description": "SourceCatalogConfig contains catalog-level custom configuration parameters for each source", "properties": { "postgres": { - "description": "Postgres-specific catalog-level configuration parameters", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig" + "description": "[Public Preview] Postgres-specific catalog-level configuration parameters", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_catalog": { - "description": "Source catalog name", - "$ref": "#/$defs/string" + "description": "[Public Preview] Source catalog name", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -9610,12 +10072,15 @@ "type": "object", "properties": { "catalog": { - "description": "Catalog-level source configuration parameters", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig" + "description": "[Public Preview] Catalog-level source configuration parameters", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "google_ads_config": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9633,36 +10098,44 @@ "type": "object", "properties": { "connector_options": { - "description": "(Optional) Source Specific Connector Options", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions" + "description": "[Public Preview] (Optional) Source Specific Connector Options", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_catalog": { - "description": "Required. Destination catalog to store table.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Destination catalog to store table.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "destination_schema": { - "description": "Required. Destination schema to store table.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Destination schema to store table.", + "$ref": "#/$defs/string", + "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.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Optional. Destination table name. The pipeline fails if a table with that name already exists. If not set, the source table name is used.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_catalog": { - "description": "Source catalog name. Might be optional depending on the type of source.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Source catalog name. Might be optional depending on the type of source.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_schema": { - "description": "Schema name in the source database. Might be optional depending on the type of source.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Schema name in the source database. Might be optional depending on the type of source.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_table": { - "description": "Required. Table name in the source database.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Required. Table name in the source database.", + "$ref": "#/$defs/string", + "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.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig" + "description": "[Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -9684,46 +10157,57 @@ "type": "object", "properties": { "auto_full_refresh_policy": { - "description": "(Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy" + "description": "[Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "exclude_columns": { - "description": "A list of column names to be excluded for the ingestion.\nWhen not specified, include_columns fully controls what columns to be ingested.\nWhen specified, all other columns including future ones will be automatically included for ingestion.\nThis field in mutually exclusive with `include_columns`.", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] A list of column names to be excluded for the ingestion.\nWhen not specified, include_columns fully controls what columns to be ingested.\nWhen specified, all other columns including future ones will be automatically included for ingestion.\nThis field in mutually exclusive with `include_columns`.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "include_columns": { - "description": "A list of column names to be included for the ingestion.\nWhen not specified, all columns except ones in exclude_columns will be included. Future\ncolumns will be automatically included.\nWhen specified, all other future columns will be automatically excluded from ingestion.\nThis field in mutually exclusive with `exclude_columns`.", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] A list of column names to be included for the ingestion.\nWhen not specified, all columns except ones in exclude_columns will be included. Future\ncolumns will be automatically included.\nWhen specified, all other future columns will be automatically excluded from ingestion.\nThis field in mutually exclusive with `exclude_columns`.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "primary_keys": { - "description": "The primary key of the table used to apply changes.", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] The primary key of the table used to apply changes.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "query_based_connector_config": { - "description": "Configurations that are only applicable for query-based ingestion connectors.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig" + "description": "[Public Preview] Configurations that are only applicable for query-based ingestion connectors.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "row_filter": { - "description": "(Optional, Immutable) The row filter condition to be applied to the table.\nIt must not contain the WHERE keyword, only the actual filter condition.\nIt must be in DBSQL format.", - "$ref": "#/$defs/string" + "description": "[Public Preview] (Optional, Immutable) The row filter condition to be applied to the table.\nIt must not contain the WHERE keyword, only the actual filter condition.\nIt must be in DBSQL format.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "salesforce_include_formula_fields": { - "description": "If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", + "description": "[Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true }, "scd_type": { - "description": "The SCD type to use to ingest the table.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType" + "description": "[Public Preview] The SCD type to use to ingest the table.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "sequence_by": { - "description": "The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order.", - "$ref": "#/$defs/slice/string" + "description": "[Public Preview] The column names specifying the logical order of events in the source data. Spark Declarative Pipelines uses this sequencing to handle change events that arrive out of order.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "workday_report_parameters": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true } }, @@ -9744,6 +10228,11 @@ "SCD_TYPE_1", "SCD_TYPE_2", "APPEND_ONLY" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -9759,32 +10248,46 @@ "description": "TikTok Ads specific options for ingestion", "properties": { "data_level": { - "description": "(Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel" + "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "dimensions": { - "description": "(Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", - "$ref": "#/$defs/slice/string" + "description": "[Private Preview] (Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", - "$ref": "#/$defs/int" + "description": "[Private Preview] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", + "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "metrics": { - "description": "(Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", - "$ref": "#/$defs/slice/string" + "description": "[Private Preview] (Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", + "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "query_lifetime": { - "description": "(Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", - "$ref": "#/$defs/bool" + "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "report_type": { - "description": "(Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType" + "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", - "$ref": "#/$defs/string" + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -9805,6 +10308,12 @@ "AUCTION_CAMPAIGN", "AUCTION_ADGROUP", "AUCTION_AD" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -9825,6 +10334,14 @@ "DSA", "BUSINESS_CENTER", "GMV_MAX" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, { @@ -9840,8 +10357,10 @@ "description": "Zendesk Support specific options for ingestion", "properties": { "start_date": { - "description": "(Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", - "$ref": "#/$defs/string" + "description": "[Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true } }, "additionalProperties": false @@ -9858,16 +10377,19 @@ "type": "object", "properties": { "enable_readable_secondaries": { - "description": "Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1.", - "$ref": "#/$defs/bool" + "description": "[Public 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-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\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec.", - "$ref": "#/$defs/int" + "description": "[Public 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-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\nthan or equal to 1.", - "$ref": "#/$defs/int" + "description": "[Public 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-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false, @@ -9889,8 +10411,9 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "pg_settings": { - "description": "A raw representation of Postgres settings.", - "$ref": "#/$defs/map/string" + "description": "[Public Beta] A raw representation of Postgres settings.", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -9909,6 +10432,10 @@ "enum": [ "ENDPOINT_TYPE_READ_WRITE", "ENDPOINT_TYPE_READ_ONLY" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, { @@ -9923,13 +10450,19 @@ "type": "object", "properties": { "budget_policy_id": { - "$ref": "#/$defs/string" + "description": "[Public Beta] Budget policy to set on the newly created pipeline.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "storage_catalog": { - "$ref": "#/$defs/string" + "description": "[Public 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-databricks-launch-stage": "PUBLIC_BETA" }, "storage_schema": { - "$ref": "#/$defs/string" + "description": "[Public 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-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -9946,12 +10479,14 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", - "$ref": "#/$defs/string" + "description": "[Public Beta] The key of the custom tag.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "value": { - "description": "The value of the custom tag.", - "$ref": "#/$defs/string" + "description": "[Public Beta] The value of the custom tag.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -9969,24 +10504,29 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "autoscaling_limit_max_cu": { - "description": "The maximum number of Compute Units. Minimum value is 0.5.", - "$ref": "#/$defs/float64" + "description": "[Public Beta] The maximum number of Compute Units. Minimum value is 0.5.", + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "autoscaling_limit_min_cu": { - "description": "The minimum number of Compute Units. Minimum value is 0.5.", - "$ref": "#/$defs/float64" + "description": "[Public Beta] The minimum number of Compute Units. Minimum value is 0.5.", + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "no_suspension": { - "description": "When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", - "$ref": "#/$defs/bool" + "description": "[Public 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-databricks-launch-stage": "PUBLIC_BETA" }, "pg_settings": { - "description": "A raw representation of Postgres settings.", - "$ref": "#/$defs/map/string" + "description": "[Public Beta] A raw representation of Postgres settings.", + "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA" }, "suspend_timeout_duration": { - "description": "Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/common/types/duration.Duration" + "description": "[Public 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-databricks-launch-stage": "PUBLIC_BETA" } }, "additionalProperties": false @@ -9998,7 +10538,26 @@ ] }, "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy": { - "type": "string" + "oneOf": [ + { + "type": "string", + "description": "Scheduling policy of the synced table's underlying pipeline.", + "enum": [ + "CONTINUOUS", + "TRIGGERED", + "SNAPSHOT" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]", + "[Beta]" + ] + }, + { + "type": "string", + "pattern": "\\$\\{(var(\\.[a-zA-Z]+([-_]?[a-zA-Z0-9]+)*(\\[[0-9]+\\])*)+)\\}" + } + ] }, "serving.Ai21LabsConfig": { "oneOf": [ @@ -10032,8 +10591,9 @@ "$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.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails" + "description": "[Public Preview] Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "inference_table_config": { "description": "Configuration for payload logging using inference tables.\nUse these tables to monitor and audit data being sent to and received from model APIs and to improve model quality.", @@ -10062,22 +10622,26 @@ "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", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "deprecated": true }, "pii": { - "description": "Configuration for guardrail PII filter.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior" + "description": "[Public Preview] Configuration for guardrail PII filter.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehavior", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "safety": { - "description": "Indicates whether the safety filter is enabled.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Indicates whether the safety filter is enabled.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "deprecated": true } @@ -10096,8 +10660,9 @@ "type": "object", "properties": { "behavior": { - "description": "Configuration for input guardrail filters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior" + "description": "[Public Preview] Configuration for input guardrail filters.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailPiiBehaviorBehavior", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -10116,6 +10681,11 @@ "NONE", "BLOCK", "MASK" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -10130,12 +10700,14 @@ "type": "object", "properties": { "input": { - "description": "Configuration for input guardrail filters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters" + "description": "[Public Preview] Configuration for input guardrail filters.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "output": { - "description": "Configuration for output guardrail filters.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters" + "description": "[Public Preview] Configuration for output guardrail filters.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrailParameters", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -10222,6 +10794,12 @@ "endpoint", "user_group", "service_principal" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -10236,6 +10814,9 @@ "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[PuPr]" ] }, { @@ -10317,6 +10898,12 @@ "cohere", "ai21labs", "amazon" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -10674,6 +11261,17 @@ "openai", "palm", "custom" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -10855,6 +11453,10 @@ "enum": [ "user", "endpoint" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, { @@ -10869,6 +11471,9 @@ "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[PuPr]" ] }, { @@ -10911,8 +11516,9 @@ "type": "object", "properties": { "burst_scaling_enabled": { - "description": "Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "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**.", @@ -10930,8 +11536,9 @@ "$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.", - "$ref": "#/$defs/string" + "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "max_provisioned_concurrency": { "description": "The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified.", @@ -10954,8 +11561,9 @@ "$ref": "#/$defs/string" }, "provisioned_model_units": { - "description": "The number of model units provisioned.", - "$ref": "#/$defs/int64" + "description": "[Public Preview] The number of model units provisioned.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { "description": "Whether the compute resources for the served entity should scale down to zero.", @@ -10984,16 +11592,18 @@ "type": "object", "properties": { "burst_scaling_enabled": { - "description": "Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "environment_vars": { "description": "An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and subject to change. Example entity environment variables that refer to Databricks secrets: `{\"OPENAI_API_KEY\": \"{{secrets/my_scope/my_key}}\", \"DATABRICKS_TOKEN\": \"{{secrets/my_scope2/my_key2}}\"}`", "$ref": "#/$defs/map/string" }, "instance_profile_arn": { - "description": "ARN of the instance profile that the served entity uses to access AWS resources.", - "$ref": "#/$defs/string" + "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "max_provisioned_concurrency": { "description": "The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified.", @@ -11022,8 +11632,9 @@ "$ref": "#/$defs/string" }, "provisioned_model_units": { - "description": "The number of model units provisioned.", - "$ref": "#/$defs/int64" + "description": "[Public Preview] The number of model units provisioned.", + "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { "description": "Whether the compute resources for the served entity should scale down to zero.", @@ -11061,7 +11672,16 @@ "GPU_MEDIUM", "GPU_SMALL", "GPU_LARGE", - "MULTIGPU_MEDIUM" + "MULTIGPU_MEDIUM", + "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, { @@ -11097,7 +11717,16 @@ "GPU_MEDIUM", "GPU_SMALL", "GPU_LARGE", - "MULTIGPU_MEDIUM" + "MULTIGPU_MEDIUM", + "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, { @@ -11137,6 +11766,16 @@ "MIN", "MAX", "STDDEV" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -11155,6 +11794,12 @@ "TRIGGERED", "OK", "ERROR" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -11170,6 +11815,10 @@ "enum": [ "ACTIVE", "DELETED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, { @@ -11184,24 +11833,29 @@ "type": "object", "properties": { "comparison_operator": { - "description": "Operator used for comparison in alert evaluation.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator" + "description": "[Public Preview] Operator used for comparison in alert evaluation.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.ComparisonOperator", + "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.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertEvaluationState" + "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-databricks-launch-stage": "PUBLIC_PREVIEW" }, "notification": { - "description": "User or Notification Destination to notify when alert is triggered.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Notification" + "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-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source": { - "description": "Source column from result to use to evaluate alert", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn" + "description": "[Public Preview] Source column from result to use to evaluate alert", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "threshold": { - "description": "Threshold to user for alert evaluation, can be a column or a value.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Operand" + "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-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -11222,15 +11876,19 @@ "type": "object", "properties": { "notify_on_ok": { - "description": "Whether to notify alert subscribers when alert returns back to normal.", - "$ref": "#/$defs/bool" + "description": "[Public Preview] Whether to notify alert subscribers when alert returns back to normal.", + "$ref": "#/$defs/bool", + "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.\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" + "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-databricks-launch-stage": "PUBLIC_PREVIEW" }, "subscriptions": { - "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription" + "description": "[Public Preview]", + "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -11247,10 +11905,14 @@ "type": "object", "properties": { "column": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn" + "description": "[Public Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "value": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue" + "description": "[Public Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -11267,13 +11929,19 @@ "type": "object", "properties": { "aggregation": { - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation" + "description": "[Public Preview]", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "display": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "name": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -11293,13 +11961,19 @@ "type": "object", "properties": { "bool_value": { - "$ref": "#/$defs/bool" + "description": "[Public Preview]", + "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "double_value": { - "$ref": "#/$defs/float64" + "description": "[Public Preview]", + "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "string_value": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -11316,12 +11990,14 @@ "type": "object", "properties": { "service_principal_name": { - "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", - "$ref": "#/$defs/string" + "description": "[Public Preview] Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.", + "$ref": "#/$defs/string", + "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.", - "$ref": "#/$defs/string" + "description": "[Public Preview] The email of an active workspace user. Can only set this field to their own email.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -11338,10 +12014,14 @@ "type": "object", "properties": { "destination_id": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "user_email": { - "$ref": "#/$defs/string" + "description": "[Public Preview]", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false @@ -11403,6 +12083,16 @@ "LESS_THAN_OR_EQUAL", "IS_NULL", "IS_NOT_NULL" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, { @@ -11418,8 +12108,7 @@ "enum": [ "TYPE_UNSPECIFIED", "CLASSIC", - "PRO", - "REYDEN" + "PRO" ] }, { @@ -11434,16 +12123,19 @@ "type": "object", "properties": { "pause_status": { - "description": "Indicate whether this schedule is paused or not.", - "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus" + "description": "[Public Preview] Indicate whether this schedule is paused or not.", + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "quartz_cron_schedule": { - "description": "A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html", - "$ref": "#/$defs/string" + "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-databricks-launch-stage": "PUBLIC_PREVIEW" }, "timezone_id": { - "description": "A Java timezone id. The schedule will be resolved using this timezone.\nThis will be combined with the quartz_cron_schedule to determine the schedule.\nSee https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.", - "$ref": "#/$defs/string" + "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-databricks-launch-stage": "PUBLIC_PREVIEW" } }, "additionalProperties": false, @@ -11502,6 +12194,10 @@ "enum": [ "UNPAUSED", "PAUSED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, { @@ -11553,8 +12249,11 @@ "description": "Type of endpoint.", "enum": [ "STORAGE_OPTIMIZED", - "STANDARD", - "STANDARD_ON_ORION" + "STANDARD" + ], + "enumDescriptions": [ + "[PuPr]", + "" ] }, { diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index ff64ac25c26..e43a5e70520 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -22,19 +22,27 @@ "type": "object", "properties": { "custom_description": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "custom_summary": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "display_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "evaluation": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Evaluation", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "file_path": { @@ -46,7 +54,9 @@ "x-since-version": "v0.279.0" }, "parent_path": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "permissions": { @@ -54,25 +64,35 @@ "x-since-version": "v0.279.0" }, "query_text": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "run_as": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2RunAs", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "run_as_user_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "warehouse_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" } }, @@ -89,7 +109,9 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.243.0" }, "compute_size": { @@ -139,22 +161,29 @@ "x-since-version": "v0.239.0" }, "space": { - "description": "Name of the space this app belongs to.", + "description": "[Private Preview] Name of the space this app belongs to.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.290.0" }, "telemetry_export_destinations": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.294.0" }, "usage_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.283.0" }, "user_api_scopes": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.246.0" } }, @@ -572,17 +601,21 @@ "type": "object", "properties": { "create_database_if_not_exists": { + "description": "[Public Preview]", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "database_instance_name": { - "description": "The name of the DatabaseInstance housing the database.", + "description": "[Public Preview] The name of the DatabaseInstance housing the database.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "database_name": { - "description": "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "lifecycle": { @@ -591,8 +624,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" } }, @@ -608,23 +642,27 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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": "[Public Beta] Custom tags associated with the instance. This field is only included on create and update responses.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.CustomTag", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.273.0" }, "enable_pg_native_login": { - "description": "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "lifecycle": { @@ -633,18 +671,21 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "permissions": { @@ -652,18 +693,21 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" }, "usage_policy_id": { - "description": "The desired usage policy to associate with the instance.", + "description": "[Public Beta] The desired usage policy to associate with the instance.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.273.0" } }, @@ -735,8 +779,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.231.0" }, "continuous": { @@ -842,9 +887,10 @@ "x-since-version": "v0.229.0" }, "usage_policy_id": { - "description": "The id of the user specified usage policy to use for this job.\nIf not specified, a default usage policy may be applied when creating or modifying the job.\nSee `effective_usage_policy_id` for the usage policy used by this workload.", + "description": "[Private Preview] The id of the user specified usage policy to use for this job.\nIf not specified, a default usage policy may be applied when creating or modifying the job.\nSee `effective_usage_policy_id` for the usage policy used by this workload.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.265.0" }, @@ -1155,8 +1201,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" }, "catalog": { @@ -1195,8 +1242,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.257.0" }, "event_log": { @@ -1210,9 +1258,10 @@ "x-since-version": "v0.229.0" }, "gateway_definition": { - "description": "The definition of a gateway pipeline to support change data capture.", + "description": "[Private Preview] The definition of a gateway pipeline to support change data capture.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionGatewayPipelineDefinition", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -1222,8 +1271,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "libraries": { @@ -1256,15 +1306,17 @@ "x-since-version": "v0.229.0" }, "restart_window": { - "description": "Restart window of this pipeline.", + "description": "[Private Preview] Restart window of this pipeline.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.RestartWindow", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.234.0" }, "root_path": { - "description": "Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", + "description": "[Public Preview] Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.253.0" }, "run_as": { @@ -1306,9 +1358,10 @@ "deprecated": true }, "usage_policy_id": { - "description": "Usage policy of this pipeline.", + "description": "[Private Preview] Usage policy of this pipeline.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.276.0" } @@ -1368,6 +1421,10 @@ "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, + "replace_existing": { + "$ref": "#/$defs/bool", + "x-since-version": "v1.0.0" + }, "source_branch": { "$ref": "#/$defs/string", "x-since-version": "v0.287.0" @@ -1395,19 +1452,24 @@ "type": "object", "properties": { "branch": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" }, "catalog_id": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" }, "create_database_if_missing": { - "$ref": "#/$defs/bool" + "$ref": "#/$defs/bool", + "x-since-version": "v1.0.0" }, "lifecycle": { - "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle" + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.0.0" }, "postgres_database": { - "$ref": "#/$defs/string" + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" } }, "additionalProperties": false, @@ -1455,6 +1517,10 @@ "$ref": "#/$defs/string", "x-since-version": "v0.287.0" }, + "replace_existing": { + "$ref": "#/$defs/bool", + "x-since-version": "v1.0.0" + }, "settings": { "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.EndpointSettings", "x-since-version": "v0.287.0" @@ -1524,6 +1590,59 @@ "project_id" ] }, + "resources.PostgresSyncedTable": { + "type": "object", + "properties": { + "branch": { + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" + }, + "create_database_objects_if_missing": { + "$ref": "#/$defs/bool", + "x-since-version": "v1.0.0" + }, + "existing_pipeline_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" + }, + "lifecycle": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.Lifecycle", + "x-since-version": "v1.0.0" + }, + "new_pipeline_spec": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.NewPipelineSpec", + "x-since-version": "v1.0.0" + }, + "postgres_database": { + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" + }, + "primary_key_columns": { + "$ref": "#/$defs/slice/string", + "x-since-version": "v1.0.0" + }, + "scheduling_policy": { + "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy", + "x-since-version": "v1.0.0" + }, + "source_table_full_name": { + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" + }, + "synced_table_id": { + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" + }, + "timeseries_key": { + "$ref": "#/$defs/string", + "x-since-version": "v1.0.0" + } + }, + "additionalProperties": false, + "required": [ + "synced_table_id" + ] + }, "resources.QualityMonitor": { "type": "object", "properties": { @@ -1543,9 +1662,10 @@ "x-since-version": "v0.229.0" }, "data_classification_config": { - "description": "[Create:OPT Update:OPT] Data classification related config.", + "description": "[Private Preview] [Create:OPT Update:OPT] Data classification related config.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDataClassificationConfig", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -1918,7 +2038,9 @@ "type": "object", "properties": { "database_instance_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" }, "lifecycle": { @@ -1926,15 +2048,21 @@ "x-since-version": "v0.268.0" }, "logical_database_name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" }, "name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" }, "spec": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/database.SyncedTableSpec", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" } }, @@ -1947,7 +2075,9 @@ "type": "object", "properties": { "budget_policy_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.298.0" }, "endpoint_type": { @@ -1967,12 +2097,16 @@ "x-since-version": "v0.298.0" }, "target_qps": { + "description": "[Public Preview]", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" }, "usage_policy_id": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" } @@ -2514,7 +2648,8 @@ }, "postgres_catalogs": { "description": "The Postgres catalog definitions for the bundle, where each key is the name of the catalog. Each entry binds a Unity Catalog catalog to a Postgres database on a Lakebase Autoscaling branch.", - "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresCatalog" + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresCatalog", + "x-since-version": "v1.0.0" }, "postgres_endpoints": { "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresEndpoint", @@ -2524,6 +2659,11 @@ "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresProject", "x-since-version": "v0.287.0" }, + "postgres_synced_tables": { + "description": "The Postgres synced table definitions for the bundle, where each key is the name of the synced table. Each entry continuously replicates a Unity Catalog Delta source table into a Postgres table on a Lakebase Autoscaling instance.", + "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.PostgresSyncedTable", + "x-since-version": "v1.0.0" + }, "quality_monitors": { "description": "The quality monitor definitions for the bundle, where each key is the name of the quality monitor.", "$ref": "#/$defs/map/github.com/databricks/cli/bundle/config/resources.QualityMonitor", @@ -3238,8 +3378,7 @@ "type": "string", "enum": [ "MEDIUM", - "LARGE", - "LIQUID" + "LARGE" ] }, "apps.ComputeState": { @@ -3527,8 +3666,10 @@ "description": "Data classification related configuration.", "properties": { "enabled": { - "description": "Whether to enable data classification.", + "description": "[Private Preview] Whether to enable data classification.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.229.0" } }, @@ -3657,9 +3798,10 @@ "x-since-version": "v0.229.0" }, "on_new_classification_tag_detected": { - "description": "Destinations to send notifications on new classification tag detected.", + "description": "[Private Preview] Destinations to send notifications on new classification tag detected.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/catalog.MonitorDestination", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" } @@ -3744,19 +3886,7 @@ "CREATE_CLEAN_ROOM", "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", - "EXTERNAL_USE_SCHEMA", - "VIEW_OBJECT", - "MANAGE_GRANTS", - "INSERT", - "UPDATE", - "DELETE", - "VIEW_ADMIN_METADATA", - "VIEW_METADATA", - "USE_VOLUME", - "READ_METADATA", - "MANAGE_ACCESS", - "MANAGE_ACCESS_CONTROL", - "CREATE_SERVICE" + "EXTERNAL_USE_SCHEMA" ] }, "catalog.PrivilegeAssignment": { @@ -4194,11 +4324,15 @@ "enum": [ "CONFIDENTIAL_COMPUTE_TYPE_NONE", "SEV_SNP" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, "compute.DataSecurityMode": { "type": "string", - "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\nThe following modes can only be used when `kind = CLASSIC_PREVIEW`.\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\n\nThe following modes can be used regardless of `kind`.\n* `NONE`: No security isolation for multiple users sharing the cluster. Data governance features are not available in this mode.\n* `SINGLE_USER`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n* `USER_ISOLATION`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other's data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", + "description": "Data security mode decides what data governance model to use when accessing data\nfrom a cluster.\n\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: A secure cluster that can be shared by multiple users. Cluster users are fully isolated so that they cannot see each other’s data and credentials. Most data governance features are supported in this mode. But programming languages and cluster features might be limited.\n* `DATA_SECURITY_MODE_DEDICATED`: A secure cluster that can only be exclusively used by a single user specified in `single_user_name`. Most programming languages, cluster features and data governance features are available in this mode.\n\nThe following modes are legacy aliases for the above modes:\n\n* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`.\n* `SINGLE_USER`: Legacy alias for `DATA_SECURITY_MODE_DEDICATED`.\n\nThe following modes are deprecated starting with Databricks Runtime 15.0 and\nwill be removed for future Databricks Runtime versions:\n\n* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters.\n* `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high concurrency clusters.\n* `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.\n* `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.", "enum": [ "NONE", "SINGLE_USER", @@ -4210,6 +4344,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": { @@ -4271,7 +4417,7 @@ "description": "The environment entity used to preserve serverless environment side panel, jobs' environment for non-notebook task, and SDP's environment for classic and serverless pipelines.\nIn this minimal environment spec, only pip and java dependencies are supported.", "properties": { "base_environment": { - "description": "The base environment this environment is built on top of. A base environment defines the environment version and a\nlist of dependencies for serverless compute. The value can be a file path to a custom `env.yaml` file\n(e.g., `/Workspace/path/to/env.yaml`). Support for a Databricks-provided base environment ID\n(e.g., `workspace-base-environments/databricks_ai_v4`) and workspace base environment ID\n(e.g., `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) is in Beta.\nEither `environment_version` or `base_environment` can be provided. For more information, see", + "description": "The base environment this environment is built on top of. A base environment defines the environment version and a\nlist of dependencies for serverless compute. The value can be a file path to a custom `env.yaml` file\n(e.g., `/Workspace/path/to/env.yaml`). Support for a Databricks-provided base environment ID\n(e.g., `workspace-base-environments/databricks_ai_v4`) and workspace base environment ID\n(e.g., `workspace-base-environments/dbe_b849b66e-b31a-4cb5-b161-1f2b10877fb7`) is in Beta.\nEither `environment_version` or `base_environment` can be provided.\nFor more information about Databricks-provided base environments, see the\n[list workspace base environments](:method:Environments/ListWorkspaceBaseEnvironments) API.\nFor more information, see", "$ref": "#/$defs/string", "x-since-version": "v0.289.0" }, @@ -4293,7 +4439,9 @@ "x-since-version": "v0.252.0" }, "java_dependencies": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.271.0" } }, @@ -4313,9 +4461,10 @@ "x-since-version": "v0.229.0" }, "confidential_compute_type": { - "description": "The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", + "description": "[Private Preview] The confidential computing technology for this cluster's instances.\nCurrently only SEV_SNP is supported, and only on N2D instance types.\nWhen not set, no confidential computing is applied.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.ConfidentialComputeType", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, @@ -4378,8 +4527,11 @@ "description": "HardwareAcceleratorType: The type of hardware accelerator to use for compute workloads.\nNOTE: This enum is referenced and is intended to be used by other Databricks services\nthat need to specify hardware accelerator requirements for AI compute workloads.", "enum": [ "GPU_1xA10", - "GPU_8xH100", - "GPU_1xH100" + "GPU_8xH100" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, "compute.InitScriptInfo": { @@ -4688,13 +4840,15 @@ "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", + "description": "[Public Preview] The key of the custom tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.273.0" } }, @@ -4705,18 +4859,21 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.265.0" } }, @@ -4730,8 +4887,15 @@ "DELETING", "STOPPED", "UPDATING", - "FAILING_OVER", - "MIGRATING" + "FAILING_OVER" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "database.DeltaTableSyncInfo": { @@ -4743,18 +4907,21 @@ "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": "[Public Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.279.0" }, "storage_catalog": { - "description": "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" } }, @@ -4769,6 +4936,14 @@ "DELETING", "UPDATING", "DEGRADED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "database.ProvisioningPhase": { @@ -4777,6 +4952,11 @@ "PROVISIONING_PHASE_MAIN", "PROVISIONING_PHASE_INDEX_SCAN", "PROVISIONING_PHASE_INDEX_SORT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "database.SyncedTableContinuousUpdateStatus": { @@ -4809,6 +4989,11 @@ "CONTINUOUS", "TRIGGERED", "SNAPSHOT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "database.SyncedTableSpec": { @@ -4816,38 +5001,45 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" } }, @@ -4868,6 +5060,19 @@ "SYNCED_TABLE_OFFLINE_FAILED", "SYNCED_TABLE_ONLINE_PIPELINE_FAILED", "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "database.SyncedTableStatus": { @@ -4875,23 +5080,27 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.266.0" } }, @@ -4925,31 +5134,56 @@ "CAN_MONITOR", "CAN_CREATE", "CAN_MONITOR_ONLY", - "CAN_CREATE_APP", - "UNSPECIFIED" + "CAN_CREATE_APP" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "[PrPr]", + "[PrPr]" ] }, "jobs.AlertTask": { "type": "object", "properties": { "alert_id": { - "description": "The alert_id is the canonical identifier of the alert.", + "description": "[Public Beta] The alert_id is the canonical identifier of the alert.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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 Beta] The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, "warehouse_id": { - "description": "The warehouse_id identifies the warehouse settings used by the alert task.", + "description": "[Public Beta] The warehouse_id identifies the warehouse settings used by the alert task.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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 Beta] The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" } }, @@ -4960,12 +5194,15 @@ "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 Beta]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, "user_name": { - "description": "A valid workspace email address.", + "description": "[Public Beta] A valid workspace email address.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" } }, @@ -4976,6 +5213,10 @@ "enum": [ "OAUTH", "PAT" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, "jobs.CleanRoomsNotebookTask": { @@ -5013,8 +5254,9 @@ "type": "object", "properties": { "hardware_accelerator": { - "description": "Hardware accelerator configuration for Serverless GPU workloads.", + "description": "[Public Beta] Hardware accelerator configuration for Serverless GPU workloads.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.HardwareAcceleratorType", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.288.0" } }, @@ -5024,18 +5266,24 @@ "type": "object", "properties": { "gpu_node_pool_id": { - "description": "IDof the GPU pool to use.", + "description": "[Private Preview] IDof the GPU pool to use.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "gpu_type": { - "description": "GPU type.", + "description": "[Private Preview] GPU type.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "num_gpus": { - "description": "Number of GPUs.", + "description": "[Private Preview] Number of GPUs.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" } }, @@ -5139,9 +5387,10 @@ "x-since-version": "v0.248.0" }, "filters": { - "description": "Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key.\nThe parameter value format is dependent on the filter type:\n- For text and single-select filters, provide a single value (e.g. `\"value\"`)\n- For date and datetime filters, provide the value in ISO 8601 format (e.g. `\"2000-01-01T00:00:00\"`)\n- For multi-select filters, provide a JSON array of values (e.g. `\"[\\\"value1\\\",\\\"value2\\\"]\"`)\n- For range and date range filters, provide a JSON object with `start` and `end` (e.g. `\"{\\\"start\\\":\\\"1\\\",\\\"end\\\":\\\"10\\\"}\"`)", + "description": "[Private Preview] Dashboard task parameters. Used to apply dashboard filter values during dashboard task execution. Parameter values get applied to any dashboard filters that have a matching URL identifier as the parameter key.\nThe parameter value format is dependent on the filter type:\n- For text and single-select filters, provide a single value (e.g. `\"value\"`)\n- For date and datetime filters, provide the value in ISO 8601 format (e.g. `\"2000-01-01T00:00:00\"`)\n- For multi-select filters, provide a JSON array of values (e.g. `\"[\\\"value1\\\",\\\"value2\\\"]\"`)\n- For range and date range filters, provide a JSON object with `start` and `end` (e.g. `\"{\\\"start\\\":\\\"1\\\",\\\"end\\\":\\\"10\\\"}\"`)", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.289.0" }, @@ -5162,13 +5411,17 @@ "description": "Deprecated in favor of DbtPlatformTask", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt Cloud for this task", + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt Cloud for this task", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.256.0" }, "dbt_cloud_job_id": { - "description": "Id of the dbt Cloud job to be triggered", + "description": "[Private Preview] Id of the dbt Cloud job to be triggered", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.256.0" } }, @@ -5178,13 +5431,17 @@ "type": "object", "properties": { "connection_resource_name": { - "description": "The resource name of the UC connection that authenticates the dbt platform for this task", + "description": "[Private Preview] The resource name of the UC connection that authenticates the dbt platform for this task", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.257.0" }, "dbt_platform_job_id": { - "description": "Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", + "description": "[Private Preview] Id of the dbt platform job to be triggered. Specified as a string for maximum compatibility with clients.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.257.0" } }, @@ -5294,42 +5551,59 @@ "type": "object", "properties": { "command": { - "description": "Command launcher to run the actual script, e.g. bash, python etc.", + "description": "[Private Preview] Command launcher to run the actual script, e.g. bash, python etc.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "compute": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ComputeConfig", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "dl_runtime_image": { - "description": "Runtime image", + "description": "[Private Preview] Runtime image", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "mlflow_experiment_name": { - "description": "Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", + "description": "[Private Preview] Optional string containing the name of the MLflow experiment to log the run to. If name is not\nfound, backend will create the mlflow experiment using the name.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "source": { - "description": "Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", + "description": "[Private Preview] Optional location type of the training script. When set to `WORKSPACE`, the script will be retrieved from the local Databricks workspace. When set to `GIT`, the script will be retrieved from a Git repository\ndefined in `git_source`. If the value is empty, the task will use `GIT` if `git_source` is defined and `WORKSPACE` otherwise.\n* `WORKSPACE`: Script is located in Databricks workspace.\n* `GIT`: Script is located in cloud Git provider.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Source", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "training_script_path": { - "description": "The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", + "description": "[Private Preview] The training script file path to be executed. Cloud file URIs (such as dbfs:/, s3:/, adls:/, gcs:/) and workspace paths are supported. For python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "yaml_parameters": { - "description": "Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", + "description": "[Private Preview] Optional string containing model parameters passed to the training script in yaml format.\nIf present, then the content in yaml_parameters_file_path will be ignored.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" }, "yaml_parameters_file_path": { - "description": "Optional path to a YAML file containing model parameters passed to the training script.", + "description": "[Private Preview] Optional path to a YAML file containing model parameters passed to the training script.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.243.0" } }, @@ -5448,6 +5722,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": { @@ -5456,6 +5734,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": { @@ -5484,8 +5766,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "on_success": { @@ -5565,9 +5848,10 @@ "description": "Write-only setting. Specifies the user or service principal that the job runs as. If not specified, the job runs as the user who created the job.\n\nEither `user_name` or `service_principal_name` should be specified. If not, an error is thrown.", "properties": { "group_name": { - "description": "Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", + "description": "[Private Preview] Group name of an account group assigned to the workspace. Setting this field requires being a member of the group.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.283.0" }, @@ -5589,18 +5873,24 @@ "description": "The source of the job specification in the remote repository when the job is source controlled.", "properties": { "dirty_state": { - "description": "Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", + "description": "[Private Preview] Dirty state indicates the job is not fully synced with the job specification in the remote repository.\n\nPossible values are:\n* `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.\n* `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.JobSourceDirtyState", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.229.0" }, "import_from_git_branch": { - "description": "Name of the branch which the job is imported from.", + "description": "[Private Preview] Name of the branch which the job is imported from.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.229.0" }, "job_config_path": { - "description": "Path of the job YAML file that contains the job specification.", + "description": "[Private Preview] Path of the job YAML file that contains the job specification.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.229.0" } }, @@ -5616,6 +5906,10 @@ "enum": [ "NOT_SYNCED", "DISCONNECTED" + ], + "enumDescriptions": [ + "[PrPr] The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.", + "[PrPr] 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": { @@ -5627,6 +5921,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": { @@ -5675,28 +5976,38 @@ "type": "object", "properties": { "aliases": { - "description": "Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", + "description": "[Private Preview] Aliases of the model versions to monitor. Can only be used in conjunction with condition MODEL_ALIAS_SET.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.279.0" }, "condition": { - "description": "The condition based on which to trigger a job run.", + "description": "[Private Preview] The condition based on which to trigger a job run.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfigurationCondition", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.279.0" }, "min_time_between_triggers_seconds": { - "description": "If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", + "description": "[Private Preview] If set, the trigger starts a run only after the specified amount of time has passed since\nthe last time the trigger fired. The minimum allowed value is 60 seconds.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.279.0" }, "securable_name": { - "description": "Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", + "description": "[Private Preview] Name of the securable to monitor (\"mycatalog.myschema.mymodel\" in the case of model-level triggers,\n\"mycatalog.myschema\" in the case of schema-level triggers) or empty in the case of metastore-level triggers.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.279.0" }, "wait_after_last_change_seconds": { - "description": "If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", + "description": "[Private Preview] If set, the trigger starts a run only after no model updates have occurred for the specified time\nand can be used to wait for a series of model updates before triggering a run. The\nminimum allowed value is 60 seconds.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.279.0" } }, @@ -5711,6 +6022,11 @@ "MODEL_CREATED", "MODEL_VERSION_READY", "MODEL_ALIAS_SET" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "jobs.NotebookTask": { @@ -5819,28 +6135,33 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" } }, @@ -5850,23 +6171,27 @@ "type": "object", "properties": { "catalog": { - "description": "The catalog name in Databricks", + "description": "[Public Preview] The catalog name in Databricks", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, "name": { - "description": "The table name in Databricks", + "description": "[Public Preview] The table name in Databricks", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, "schema": { - "description": "The schema name in Databricks", + "description": "[Public Preview] The schema name in Databricks", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, "storage_mode": { - "description": "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" } }, @@ -5876,28 +6201,33 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" } }, @@ -5957,24 +6287,34 @@ "AT_LEAST_ONE_SUCCESS", "ALL_FAILED", "AT_LEAST_ONE_FAILED" + ], + "enumDescriptions": [ + "All dependencies have executed and succeeded", + "All dependencies have been completed", + "None of the dependencies have failed and at least one was executed", + "At least one dependency has succeeded", + "ALl dependencies have failed", + "At least one dependency failed" ] }, "jobs.RunJobTask": { "type": "object", "properties": { "dbt_commands": { - "description": "An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] An array of commands to execute for jobs with the dbt task, for example `\"dbt_commands\": [\"dbt deps\", \"dbt seed\", \"dbt deps\", \"dbt seed\", \"dbt run\"]`\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", "deprecated": true }, "jar_params": { - "description": "A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\", \"35\"]`.\nThe parameters are used to invoke the main function of the main class specified in the Spark JAR task.\nIf not specified upon `run-now`, it defaults to an empty list.\njar_params cannot be specified in conjunction with notebook_params.\nThe JSON representation of this field (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -5991,9 +6331,10 @@ "x-since-version": "v0.229.0" }, "notebook_params": { - "description": "A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.", + "description": "[Private Preview] A map from keys to values for jobs with notebook task, for example `\"notebook_params\": {\"name\": \"john doe\", \"age\": \"35\"}`.\nThe map is passed to the notebook and is accessible through the [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html) function.\n\nIf not specified upon `run-now`, the triggered run uses the job’s base parameters.\n\nnotebook_params cannot be specified in conjunction with jar_params.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nThe JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6005,35 +6346,40 @@ "x-since-version": "v0.229.0" }, "python_named_params": { + "description": "[Private Preview]", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", "deprecated": true }, "python_params": { - "description": "A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", + "description": "[Private Preview] A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\", \"35\"]`.\nThe parameters are passed to Python file as command-line parameters. If specified upon `run-now`, it would overwrite\nthe parameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", "deprecated": true }, "spark_submit_params": { - "description": "A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", + "description": "[Private Preview] A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]`.\nThe parameters are passed to spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite the\nparameters specified in job setting. The JSON representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`)\ncannot exceed 10,000 bytes.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.\n\nImportant\n\nThese parameters accept only Latin characters (ASCII character set). Using non-ASCII characters returns an error.\nExamples of invalid, non-ASCII characters are Chinese, Japanese kanjis, and emojis.", "$ref": "#/$defs/slice/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", "deprecated": true }, "sql_params": { - "description": "A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", + "description": "[Private Preview] A map from keys to values for jobs with SQL task, for example `\"sql_params\": {\"name\": \"john doe\", \"age\": \"35\"}`. The SQL alert task does not support custom parameters.\n\n⚠ **Deprecation note** Use [job parameters](https://docs.databricks.com/jobs/job-parameters.html#job-parameter-pushdown) to pass information down to tasks.", "$ref": "#/$defs/map/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.229.0", @@ -6051,6 +6397,10 @@ "enum": [ "WORKSPACE", "GIT" + ], + "enumDescriptions": [ + "SQL file is located in \u003cDatabricks\u003e workspace.", + "SQL file is located in cloud Git provider." ] }, "jobs.SparkJarTask": { @@ -6276,6 +6626,11 @@ "DIRECT_QUERY", "IMPORT", "DUAL" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "jobs.Subscription": { @@ -6345,8 +6700,9 @@ "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 Beta] The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, "clean_rooms_notebook_task": { @@ -6355,8 +6711,9 @@ "x-since-version": "v0.237.0" }, "compute": { - "description": "Task level compute configuration.", + "description": "[Public Beta] Task level compute configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.288.0" }, "condition_task": { @@ -6370,17 +6727,20 @@ "x-since-version": "v0.248.0" }, "dbt_cloud_task": { - "description": "Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", + "description": "[Private Preview] Task type for dbt cloud, deprecated in favor of the new name dbt_platform_task", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtCloudTask", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", "doNotSuggest": true, "x-since-version": "v0.256.0", "deprecated": true }, "dbt_platform_task": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.DbtPlatformTask", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.257.0" }, @@ -6407,8 +6767,6 @@ "disabled": { "description": "An optional flag to disable the task. If set to true, the task will not run even if it is part of a job.", "$ref": "#/$defs/bool", - "x-databricks-preview": "PRIVATE", - "doNotSuggest": true, "x-since-version": "v0.271.0" }, "email_notifications": { @@ -6432,8 +6790,10 @@ "x-since-version": "v0.229.0" }, "gen_ai_compute_task": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.GenAiComputeTask", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.243.0" }, @@ -6482,8 +6842,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, "python_wheel_task": { @@ -6594,8 +6955,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "on_success": { @@ -6644,8 +7006,10 @@ "x-since-version": "v0.229.0" }, "model": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.ModelTriggerConfiguration", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, @@ -6698,8 +7062,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "on_success": { @@ -6769,13 +7134,15 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.285.0" } }, @@ -6789,8 +7156,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" } }, @@ -6800,9 +7168,10 @@ "type": "object", "properties": { "source_catalog": { - "description": "Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", + "description": "[Private Preview] Source catalog for initial connection.\nThis is necessary for schema exploration in some database systems like Oracle, and optional but nice-to-have\nin some other database systems like Postgres.\nFor Oracle databases, this maps to a service name.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" } @@ -6814,64 +7183,76 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" }, "gdrive_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "google_ads_options": { - "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", + "description": "[Private Preview] Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "jira_options": { - "description": "Jira specific options for ingestion", + "description": "[Public Beta] Jira specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "meta_ads_options": { - "description": "Meta Marketing (Meta Ads) specific options for ingestion", + "description": "[Public Beta] Meta Marketing (Meta Ads) specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "outlook_options": { - "description": "Outlook specific options for ingestion", + "description": "[Private Preview] Outlook specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "sharepoint_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "smartsheet_options": { - "description": "Smartsheet specific options for ingestion", + "description": "[Private Preview] Smartsheet specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SmartsheetOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" }, "tiktok_ads_options": { - "description": "TikTok Ads specific options for ingestion", + "description": "[Private Preview] TikTok Ads specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.298.0" }, "zendesk_support_options": { - "description": "Zendesk Support specific options for ingestion", + "description": "[Private Preview] Zendesk Support specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ZendeskSupportOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -6884,6 +7265,10 @@ "enum": [ "CDC", "QUERY_BASED" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, "pipelines.CronTrigger": { @@ -6905,18 +7290,24 @@ "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": "[Private Preview] (Required, Immutable) The name of the catalog for the connector's staging storage location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.296.0" }, "schema_name": { - "description": "(Required, Immutable) The name of the schema for the connector's staging storage location.", + "description": "[Private Preview] (Required, Immutable) The name of the schema for the connector's staging storage location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "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": "[Private Preview] (Optional) The Unity Catalog-compatible name for the storage location.\nThis is the volume to use for the data that is extracted by the connector.\nSpark Declarative Pipelines system will automatically create the volume under the catalog and schema.\nFor Combined Cdc Managed Ingestion pipelines default name for the volume would be :\n__databricks_ingestion_gateway_staging_data-$pipelineId", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.296.0" } }, @@ -6937,6 +7328,15 @@ "FRIDAY", "SATURDAY", "SUNDAY" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "pipelines.DeploymentKind": { @@ -6972,18 +7372,24 @@ "type": "object", "properties": { "modified_after": { - "description": "Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", + "description": "[Private Preview] Include files with modification times occurring after the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "modified_before": { - "description": "Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", + "description": "[Private Preview] Include files with modification times occurring before the specified time.\nTimestamp format: YYYY-MM-DDTHH:mm:ss (e.g. 2020-06-01T13:00:00)\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#modification-time-path-filters", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "path_filter": { - "description": "Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", + "description": "[Private Preview] Include files with file names matching the pattern\nBased on https://spark.apache.org/docs/latest/sql-data-sources-generic-options.html#path-glob-filter", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -6993,53 +7399,80 @@ "type": "object", "properties": { "corrupt_record_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_filters": { - "description": "Generic options", + "description": "[Private Preview] Generic options", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.FileFilter", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format": { - "description": "required for TableSpec", + "description": "[Private Preview] required for TableSpec", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsFileFormat", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "format_options": { - "description": "Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", + "description": "[Private Preview] Format-specific options\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/options#file-format-options", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "ignore_corrupt_files": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "infer_column_types": { + "description": "[Private Preview]", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "reader_case_sensitive": { - "description": "Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", + "description": "[Private Preview] Column name case sensitivity\nhttps://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#change-case-sensitive-behavior", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "rescued_data_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "schema_evolution_mode": { - "description": "Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", + "description": "[Private Preview] Based on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptionsSchemaEvolutionMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "schema_hints": { - "description": "Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", + "description": "[Private Preview] Override inferred schema of specific columns\nBased on https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#override-schema-inference-with-schema-hints", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "single_variant_column": { + "description": "[Private Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -7056,6 +7489,16 @@ "PARQUET", "AVRO", "ORC" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.FileIngestionOptionsSchemaEvolutionMode": { @@ -7067,6 +7510,13 @@ "RESCUE", "FAIL_ON_NEW_COLUMNS", "NONE" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.FileLibrary": { @@ -7100,8 +7550,10 @@ "type": "object", "properties": { "manager_account_id": { - "description": "(Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", + "description": "[Private Preview] (Required) Manager Account ID (also called MCC Account ID) used to list and access\ncustomer accounts under this manager account. This is required for fetching the list\nof customer accounts during source selection.\nIf the same field is also set in the object-level GoogleAdsOptions (connector_options),\nthe object-level value takes precedence over this top-level config.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" } }, @@ -7112,18 +7564,24 @@ "description": "Google Ads specific options for ingestion (object-level).\nWhen set, these values override the corresponding fields in GoogleAdsConfig\n(source_configurations).", "properties": { "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", + "description": "[Private Preview] (Optional) Number of days to look back for report tables to capture late-arriving data.\nIf not specified, defaults to 30 days.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "manager_account_id": { - "description": "(Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", + "description": "[Private Preview] (Optional at this level) Manager Account ID (also called MCC Account ID) used to list\nand access customer accounts under this manager account.\nOverrides GoogleAdsConfig.manager_account_id from source_configurations when set.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 2 years of historical data.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -7136,16 +7594,24 @@ "type": "object", "properties": { "entity_type": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleDriveOptionsGoogleDriveEntityType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_ingestion_options": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "url": { - "description": "Google Drive URL.", + "description": "[Private Preview] Google Drive URL.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -7157,24 +7623,32 @@ "FILE", "FILE_METADATA", "PERMISSION" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" } }, @@ -7184,37 +7658,48 @@ "type": "object", "properties": { "connection_id": { - "description": "[Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "description": "[Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "x-since-version": "v0.229.0", "deprecated": true }, "connection_name": { - "description": "Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", + "description": "[Private Preview] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.234.0" }, "connection_parameters": { - "description": "Optional, Internal. Parameters required to establish an initial connection with the source.", + "description": "[Private Preview] Optional, Internal. Parameters required to establish an initial connection with the source.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectionParameters", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.279.0" }, "gateway_storage_catalog": { - "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", + "description": "[Private Preview] Required, Immutable. The name of the catalog for the gateway pipeline's storage location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.229.0" }, "gateway_storage_name": { - "description": "Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", + "description": "[Private Preview] Optional. The Unity Catalog-compatible name for the gateway storage location.\nThis is the destination to use for the data that is extracted by the gateway.\nSpark Declarative Pipelines system will automatically create the storage location under the catalog and schema.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.229.0" }, "gateway_storage_schema": { - "description": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.", + "description": "[Private Preview] Required, Immutable. The name of the schema for the gateway pipelines's storage location.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.229.0" } }, @@ -7229,58 +7714,69 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "connector_type": { - "description": "(Optional) Connector Type for sources. Ex: CDC, Query Based.", + "description": "[Private Preview] (Optional) Connector Type for sources. Ex: CDC, Query Based.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorType", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.296.0" }, "data_staging_options": { - "description": "(Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", + "description": "[Private Preview] (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline\nwith Gateway pipeline to Combined Cdc Managed Ingestion Pipeline.\nIf not specified, the volume for staged data will be created in catalog and schema/target specified in the\ntop level pipeline definition.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.DataStagingOptions", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.296.0" }, "full_refresh_window": { - "description": "(Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", + "description": "[Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.285.0" }, "ingest_from_uc_foreign_catalog": { - "description": "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "netsuite_jar_path": { + "description": "[Private Preview]", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" }, "objects": { - "description": "Required. Settings specifying tables to replicate and the destination for the replicated tables.", + "description": "[Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionConfig", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" } }, @@ -7291,18 +7787,21 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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": "[Public Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", "$ref": "#/$defs/int64", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.264.0" } }, @@ -7312,21 +7811,27 @@ "type": "object", "properties": { "incremental": { - "description": "(Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", + "description": "[Private Preview] (Optional) Marks the report as incremental.\nThis field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now\ncontrolled by the `parameters` field.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "x-since-version": "v0.271.0", "deprecated": true }, "parameters": { - "description": "Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", + "description": "[Private Preview] Parameters for the Workday report. Each key represents the parameter name (e.g., \"start_date\", \"end_date\"),\nand the corresponding value is a SQL-like expression used to compute the parameter value at runtime.\nExample:\n{\n\"start_date\": \"{ coalesce(current_offset(), date(\\\"2025-02-01\\\")) }\",\n\"end_date\": \"{ current_date() - INTERVAL 1 DAY }\"\n}", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.271.0" }, "report_parameters": { - "description": "(Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", + "description": "[Private Preview] (Optional) Additional custom parameters for Workday Report\nThis field is deprecated and should not be used. Use `parameters` instead.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "x-since-version": "v0.271.0", "deprecated": true } @@ -7337,13 +7842,17 @@ "type": "object", "properties": { "key": { - "description": "Key for the report parameter, can be a column name or other metadata", + "description": "[Private Preview] Key for the report parameter, can be a column name or other metadata", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.271.0" }, "value": { - "description": "Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", + "description": "[Private Preview] Value for the report parameter.\nPossible values it can take are these sql functions:\n1. coalesce(current_offset(), date(\"YYYY-MM-DD\")) -\u003e if current_offset() is null, then the passed date, else current_offset()\n2. current_date()\n3. date_sub(current_date(), x) -\u003e subtract x (some non-negative integer) days from current date", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.271.0" } }, @@ -7354,8 +7863,6 @@ "enum": [ "MYSQL", "POSTGRESQL", - "REDSHIFT", - "SQLDW", "SQLSERVER", "SALESFORCE", "BIGQUERY", @@ -7372,87 +7879,30 @@ "JIRA", "CONFLUENCE", "META_MARKETING", - "GOOGLE_ADS", - "TIKTOK_ADS", - "SALESFORCE_MARKETING_CLOUD", - "HUBSPOT", - "WORKDAY_HCM", - "GUIDEWIRE", "ZENDESK", - "COMMUNITY", - "SLACK_AUDIT_LOGS", - "KAFKA", - "CROWDSTRIKE_EVENT_STREAM", - "WORKDAY_ACTIVITY_LOGGING", - "AKAMAI_WAF", - "VEEVA", - "VEEVA_VAULT", - "M365_AUDIT_LOGS", - "OKTA_SYSTEM_LOGS", - "ONE_PASSWORD_EVENT_LOGS", - "PROOFPOINT_SIEM", - "WIZ_AUDIT_LOGS", - "GITHUB", - "OUTLOOK", - "SMARTSHEET", - "MICROSOFT_TEAMS", - "ADOBE_CAMPAIGNS", - "LINKEDIN_ADS", - "X_ADS", - "BING_ADS", - "GOOGLE_SEARCH_CONSOLE", - "PINTEREST_ADS", - "REDDIT_ADS", - "PENDO", - "API_SOURCE", - "SLACK_ACCESS_AND_INTEGRATION_LOGS", - "ORACLE_FUSION_CLOUD", - "RABBITMQ", - "GOOGLE_ANALYTICS", - "AMPLITUDE", - "NOTION", - "ADP_WORKFORCE_NOW", - "SAS", - "GONG", - "SALESLOFT", - "GOOGLE_WORKSPACE", - "SHOPIFY", - "ORACLE_ELOQUA", - "EPIC_CLARITY", - "LINEAR", - "APPLE_APP_STORE", - "SPLUNK", - "GITLAB", - "ZOOM_LOGS", - "MONDAY_COM", - "AIRTABLE", - "MICROSOFT_ENTRA_ID", - "PAGERDUTY", - "APPFIGURES", - "ADOBE_COMMERCE", - "QUICKBOOKS", - "SQUARE", - "ZOHO_BOOKS", - "SNAPCHAT_ADS", - "GENESYS", - "SAP_SUCCESSFACTORS", - "YOUTUBE_ANALYTICS", - "CERIDIAN_DAYFORCE", - "FRESHSERVICE", - "SENDGRID", - "AZURE_MONITOR_LOGS", - "ATLASSIAN_ORGANIZATION", - "HIBOB", - "APPLE_SEARCH_ADS", - "AWIN", - "DELIGHTED", - "FRONT", - "GURU", - "PARTNERSTACK", - "MARKETO", - "AHA", - "NETSKOPE_LOGS", "FOREIGN_CATALOG" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PrPr]", + "[Beta]", + "[PuPr]", + "[Beta]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.JiraConnectorOptions": { @@ -7460,8 +7910,9 @@ "description": "Jira specific options for ingestion", "properties": { "include_jira_spaces": { - "description": "(Optional) Projects to filter Jira data on", + "description": "[Public Beta] (Optional) Projects to filter Jira data on", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" } }, @@ -7476,43 +7927,51 @@ "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": "[Public Beta] (Optional) Action attribution windows for insights reporting (e.g. \"28d_click\", \"1d_view\")", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "action_breakdowns": { - "description": "(Optional) Action breakdowns to configure for data aggregation", + "description": "[Public Beta] (Optional) Action breakdowns to configure for data aggregation", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "action_report_time": { - "description": "(Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", + "description": "[Public Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime)", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "breakdowns": { - "description": "(Optional) Breakdowns to configure for data aggregation", + "description": "[Public Beta] (Optional) Breakdowns to configure for data aggregation", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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": "[Public Beta] (Optional) Window in days to revisit data during sync to capture\nupdated conversion data from the API.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "level": { - "description": "(Optional) Granularity of data to pull (account, ad, adset, campaign)", + "description": "[Public Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign)", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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": "[Public 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-databricks-launch-stage": "PUBLIC_BETA", "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": "[Public Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days)", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" } }, @@ -7550,18 +8009,21 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.285.0" } }, @@ -7578,6 +8040,12 @@ "NON_INLINE_ONLY", "INLINE_ONLY", "NONE" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.OutlookBodyFormat": { @@ -7586,6 +8054,10 @@ "enum": [ "TEXT_HTML", "TEXT_PLAIN" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]" ] }, "pipelines.OutlookOptions": { @@ -7593,58 +8065,78 @@ "description": "Outlook specific options for ingestion", "properties": { "attachment_mode": { - "description": "(Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", + "description": "[Private Preview] (Optional) Controls which attachments to ingest.\nIf not specified, defaults to ALL.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookAttachmentMode", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "body_format": { - "description": "(Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", + "description": "[Private Preview] (Optional) Defines how the body_content column is populated.\nTEXT_HTML: Preserves full formatting, links, and styling.\nTEXT_PLAIN: Converts body to plain text. Recommended for AI/RAG pipelines to reduce token usage and noise.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OutlookBodyFormat", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "folder_filter": { - "description": "Deprecated. Use include_folders instead.", + "description": "[Private Preview] Deprecated. Use include_folders instead.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "x-since-version": "v0.299.2", "deprecated": true }, "include_folders": { - "description": "(Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", + "description": "[Private Preview] (Optional) Filter mail folders to include in the sync.\nIf not specified, all folders will be synced.\nExamples: Inbox, Sent Items, Custom_Folder\nFilter semantics: OR between different folders.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_mailboxes": { - "description": "(Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", + "description": "[Private Preview] (Optional) List of mailboxes to sync (e.g. mailbox email addresses or identifiers).\nIf not specified, all accessible mailboxes are ingested.\nFilter semantics: OR between different mailboxes.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_senders": { - "description": "(Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", + "description": "[Private Preview] (Optional) Filter emails by sender address. Uses exact email match.\nExamples: user@vendor.com, alerts@system.io, noreply@company.com\nIf not specified, emails from all senders will be synced.\nFilter semantics: OR between different senders.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "include_subjects": { - "description": "(Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", + "description": "[Private Preview] (Optional) Filter emails by subject line. Values ending with \"*\" use prefix match (subject starts with\nthe part before \"*\"); otherwise substring match (subject contains the value).\nExamples: \"Invoice\" (substring), \"Re:*\" (prefix), \"Support Ticket\", \"URGENT*\"\nIf not specified, emails with all subjects will be synced.\nFilter semantics: OR between different subjects.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "sender_filter": { - "description": "Deprecated. Use include_senders instead.", + "description": "[Private Preview] Deprecated. Use include_senders instead.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "x-since-version": "v0.299.2", "deprecated": true }, "start_date": { - "description": "(Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", + "description": "[Private Preview] (Optional) Start date for the initial sync in YYYY-MM-DD format.\nFormat: YYYY-MM-DD (e.g., 2024-01-01)\nThis determines the earliest date from which to sync historical data.\nIf not specified, complete history is ingested.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" }, "subject_filter": { - "description": "Deprecated. Use include_subjects instead.", + "description": "[Private Preview] Deprecated. Use include_subjects instead.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "deprecationMessage": "This field is deprecated", + "doNotSuggest": true, "x-since-version": "v0.299.2", "deprecated": true } @@ -7655,8 +8147,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.252.0" } }, @@ -7824,21 +8317,24 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.252.0" }, "jar": { - "description": "URI of the jar to be installed. Currently only DBFS is supported.", + "description": "[Private Preview] URI of the jar to be installed. Currently only DBFS is supported.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "maven": { - "description": "Specification of a maven library to be installed.", + "description": "[Private Preview] Specification of a maven library to be installed.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/compute.MavenLibrary", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, @@ -7886,14 +8382,16 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.257.0" }, "environment_version": { - "description": "The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", + "description": "[Private Preview] The environment version of the serverless Python environment used to execute\ncustomer Python code. Each environment version includes a specific Python\nversion and a curated set of pre-installed libraries with defined versions,\nproviding a stable and reproducible execution environment.\n\nDatabricks supports a three-year lifecycle for each environment version.\nFor available versions and their included packages, see\nhttps://docs.databricks.com/aws/en/release-notes/serverless/environment-version/\n\nThe value should be a string representing the environment version number, for example: `\"4\"`.", "$ref": "#/$defs/string", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.294.0" } @@ -7905,8 +8403,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" } }, @@ -7917,13 +8416,15 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" } }, @@ -7933,28 +8434,33 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.231.0" } }, @@ -7969,18 +8475,24 @@ "type": "object", "properties": { "days_of_week": { - "description": "Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", + "description": "[Private Preview] Days of week in which the restart is allowed to happen (within a five-hour window starting at start_hour).\nIf not specified all days of the week will be used.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.DayOfWeek", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.234.0" }, "start_hour": { - "description": "An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", + "description": "[Private Preview] An integer between 0 and 23 denoting the start hour for the restart window in the 24-hour day.\nContinuous pipeline restart is triggered only within a five-hour window starting at this hour.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.234.0" }, "time_zone_id": { - "description": "Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", + "description": "[Private Preview] Time zone id of restart window. See https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details.\nIf not specified, UTC will be used.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.234.0" } }, @@ -8010,33 +8522,39 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" } }, @@ -8051,18 +8569,24 @@ "type": "object", "properties": { "entity_type": { - "description": "(Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", + "description": "[Private Preview] (Optional) The type of SharePoint entity to ingest.\nIf not specified, defaults to FILE.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SharepointOptionsSharepointEntityType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "file_ingestion_options": { - "description": "(Optional) File ingestion options for processing files.", + "description": "[Private Preview] (Optional) File ingestion options for processing files.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.FileIngestionOptions", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "url": { - "description": "Required. The SharePoint URL.", + "description": "[Private Preview] Required. The SharePoint URL.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -8075,6 +8599,12 @@ "FILE_METADATA", "PERMISSION", "LIST" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.SmartsheetOptions": { @@ -8082,8 +8612,10 @@ "description": "Smartsheet specific options for ingestion", "properties": { "enforce_schema": { - "description": "(Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", + "description": "[Private Preview] (Optional) When true, maps each column to its Smartsheet-declared type (Text/Number/Date/\nCheckbox/etc.). Cells that do not conform to the declared type are set to NULL.\nWhen false, all columns land as STRING. Use false for sheets with irregular data or columns\nthat frequently violate their own declared type.\nIf not specified, defaults to true.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" } }, @@ -8094,13 +8626,15 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" }, "source_catalog": { - "description": "Source catalog name", + "description": "[Public Preview] Source catalog name", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" } }, @@ -8110,13 +8644,16 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" }, "google_ads_config": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.GoogleAdsConfig", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.299.2" } @@ -8127,43 +8664,51 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" } }, @@ -8178,55 +8723,66 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.283.0" }, "salesforce_include_formula_fields": { - "description": "If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", + "description": "[Private Preview] If true, formula fields defined in the table are included in the ingestion. This setting is only valid for the Salesforce connector", "$ref": "#/$defs/bool", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.229.0" }, "scd_type": { - "description": "The SCD type to use to ingest the table.", + "description": "[Public Preview] The SCD type to use to ingest the table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.231.0" }, "workday_report_parameters": { + "description": "[Private Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters", "x-databricks-preview": "PRIVATE", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", "doNotSuggest": true, "x-since-version": "v0.271.0" } @@ -8240,6 +8796,11 @@ "SCD_TYPE_1", "SCD_TYPE_2", "APPEND_ONLY" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "pipelines.TikTokAdsOptions": { @@ -8247,38 +8808,52 @@ "description": "TikTok Ads specific options for ingestion", "properties": { "data_level": { - "description": "(Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", + "description": "[Private Preview] (Optional) Data level for the report.\nIf not specified, defaults to AUCTION_CAMPAIGN.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokDataLevel", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "dimensions": { - "description": "(Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", + "description": "[Private Preview] (Optional) Dimensions to include in the report.\nExamples: \"campaign_id\", \"adgroup_id\", \"ad_id\", \"stat_time_day\", \"stat_time_hour\"\nIf not specified, defaults to campaign_id.", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "lookback_window_days": { - "description": "(Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", + "description": "[Private Preview] (Optional) Number of days to look back for report tables during incremental sync\nto capture late-arriving conversions and attribution data.\nIf not specified, defaults to 7 days.", "$ref": "#/$defs/int", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "metrics": { - "description": "(Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", + "description": "[Private Preview] (Optional) Metrics to include in the report.\nExamples: \"spend\", \"impressions\", \"clicks\", \"conversion\", \"cpc\"\nIf not specified, defaults to basic metrics (spend, impressions, clicks, etc.)", "$ref": "#/$defs/slice/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "query_lifetime": { - "description": "(Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", + "description": "[Private Preview] (Optional) Whether to request lifetime metrics (all-time aggregated data).\nWhen true, the report returns all-time data.\nIf not specified, defaults to false.", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "report_type": { - "description": "(Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", + "description": "[Private Preview] (Optional) Report type for the TikTok Ads API.\nIf not specified, defaults to BASIC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TikTokAdsOptionsTikTokReportType", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" }, "sync_start_date": { - "description": "(Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", + "description": "[Private Preview] (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format.\nThis determines the earliest date from which to sync historical data.\nIf not specified, defaults to 1 year of historical data for daily reports\nand 30 days for hourly reports.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.298.0" } }, @@ -8292,6 +8867,12 @@ "AUCTION_CAMPAIGN", "AUCTION_ADGROUP", "AUCTION_AD" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.TikTokAdsOptionsTikTokReportType": { @@ -8304,6 +8885,14 @@ "DSA", "BUSINESS_CENTER", "GMV_MAX" + ], + "enumDescriptions": [ + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]", + "[PrPr]" ] }, "pipelines.ZendeskSupportOptions": { @@ -8311,8 +8900,10 @@ "description": "Zendesk Support specific options for ingestion", "properties": { "start_date": { - "description": "(Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", + "description": "[Private Preview] (Optional) Start date in YYYY-MM-DD format for the initial sync.\nThis determines the earliest date from which to sync historical data.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PRIVATE_PREVIEW", + "doNotSuggest": true, "x-since-version": "v0.299.2" } }, @@ -8322,18 +8913,21 @@ "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": "[Public 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-databricks-launch-stage": "PUBLIC_BETA", "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": "[Public 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-databricks-launch-stage": "PUBLIC_BETA", "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": "[Public 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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.290.0" } }, @@ -8348,8 +8942,9 @@ "description": "A collection of settings for a compute endpoint.", "properties": { "pg_settings": { - "description": "A raw representation of Postgres settings.", + "description": "[Public Beta] A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" } }, @@ -8361,19 +8956,49 @@ "enum": [ "ENDPOINT_TYPE_READ_WRITE", "ENDPOINT_TYPE_READ_ONLY" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]" ] }, + "postgres.NewPipelineSpec": { + "type": "object", + "properties": { + "budget_policy_id": { + "description": "[Public Beta] Budget policy to set on the newly created pipeline.", + "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.0.0" + }, + "storage_catalog": { + "description": "[Public 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-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.0.0" + }, + "storage_schema": { + "description": "[Public 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-databricks-launch-stage": "PUBLIC_BETA", + "x-since-version": "v1.0.0" + } + }, + "additionalProperties": false + }, "postgres.ProjectCustomTag": { "type": "object", "properties": { "key": { - "description": "The key of the custom tag.", + "description": "[Public Beta] The key of the custom tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.290.0" }, "value": { - "description": "The value of the custom tag.", + "description": "[Public Beta] The value of the custom tag.", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.290.0" } }, @@ -8384,33 +9009,52 @@ "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": "[Public Beta] The maximum number of Compute Units. Minimum value is 0.5.", "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "autoscaling_limit_min_cu": { - "description": "The minimum number of Compute Units. Minimum value is 0.5.", + "description": "[Public Beta] The minimum number of Compute Units. Minimum value is 0.5.", "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "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": "[Public 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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" }, "pg_settings": { - "description": "A raw representation of Postgres settings.", + "description": "[Public Beta] A raw representation of Postgres settings.", "$ref": "#/$defs/map/string", + "x-databricks-launch-stage": "PUBLIC_BETA", "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": "[Public 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-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.287.0" } }, "additionalProperties": false }, + "postgres.SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy": { + "type": "string", + "description": "Scheduling policy of the synced table's underlying pipeline.", + "enum": [ + "CONTINUOUS", + "TRIGGERED", + "SNAPSHOT" + ], + "enumDescriptions": [ + "[Beta]", + "[Beta]", + "[Beta]" + ] + }, "serving.Ai21LabsConfig": { "type": "object", "properties": { @@ -8436,8 +9080,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" }, "inference_table_config": { @@ -8462,25 +9107,29 @@ "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", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "deprecationMessage": "This field is deprecated", "x-since-version": "v0.230.0", "deprecated": true @@ -8492,8 +9141,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" } }, @@ -8505,19 +9155,26 @@ "NONE", "BLOCK", "MASK" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" } }, @@ -8590,12 +9247,21 @@ "endpoint", "user_group", "service_principal" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "serving.AiGatewayRateLimitRenewalPeriod": { "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[PuPr]" ] }, "serving.AiGatewayUsageTrackingConfig": { @@ -8661,6 +9327,12 @@ "cohere", "ai21labs", "amazon" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "serving.AnthropicConfig": { @@ -8962,6 +9634,17 @@ "openai", "palm", "custom" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "serving.FallbackConfig": { @@ -9116,12 +9799,19 @@ "enum": [ "user", "endpoint" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, "serving.RateLimitRenewalPeriod": { "type": "string", "enum": [ "minute" + ], + "enumDescriptions": [ + "[PuPr]" ] }, "serving.Route": { @@ -9151,8 +9841,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.288.0" }, "entity_name": { @@ -9175,8 +9866,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "max_provisioned_concurrency": { @@ -9205,8 +9897,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.252.0" }, "scale_to_zero_enabled": { @@ -9231,8 +9924,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.288.0" }, "environment_vars": { @@ -9241,8 +9935,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, "max_provisioned_concurrency": { @@ -9279,8 +9974,9 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.252.0" }, "scale_to_zero_enabled": { @@ -9314,7 +10010,16 @@ "GPU_MEDIUM", "GPU_SMALL", "GPU_LARGE", - "MULTIGPU_MEDIUM" + "MULTIGPU_MEDIUM", + "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, "serving.ServingEndpointPermissionLevel": { @@ -9334,7 +10039,16 @@ "GPU_MEDIUM", "GPU_SMALL", "GPU_LARGE", - "MULTIGPU_MEDIUM" + "MULTIGPU_MEDIUM", + "GPU_XLARGE" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "[Beta]" ] }, "serving.TrafficConfig": { @@ -9359,6 +10073,16 @@ "MIN", "MAX", "STDDEV" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "sql.AlertEvaluationState": { @@ -9369,6 +10093,12 @@ "TRIGGERED", "OK", "ERROR" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "sql.AlertLifecycleState": { @@ -9376,34 +10106,43 @@ "enum": [ "ACTIVE", "DELETED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" } }, @@ -9417,17 +10156,21 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "subscriptions": { + "description": "[Public Preview]", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/sql.AlertV2Subscription", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" } }, @@ -9437,11 +10180,15 @@ "type": "object", "properties": { "column": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandColumn", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "value": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.AlertV2OperandValue", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" } }, @@ -9451,15 +10198,21 @@ "type": "object", "properties": { "aggregation": { + "description": "[Public Preview]", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.Aggregation", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "display": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "name": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" } }, @@ -9472,15 +10225,21 @@ "type": "object", "properties": { "bool_value": { + "description": "[Public Preview]", "$ref": "#/$defs/bool", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "double_value": { + "description": "[Public Preview]", "$ref": "#/$defs/float64", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "string_value": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" } }, @@ -9490,13 +10249,15 @@ "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" } }, @@ -9506,11 +10267,15 @@ "type": "object", "properties": { "destination_id": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, "user_email": { + "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" } }, @@ -9551,6 +10316,16 @@ "LESS_THAN_OR_EQUAL", "IS_NULL", "IS_NOT_NULL" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]", + "[PuPr]" ] }, "sql.CreateWarehouseRequestWarehouseType": { @@ -9558,26 +10333,28 @@ "enum": [ "TYPE_UNSPECIFIED", "CLASSIC", - "PRO", - "REYDEN" + "PRO" ] }, "sql.CronSchedule": { "type": "object", "properties": { "pause_status": { - "description": "Indicate whether this schedule is paused or not.", + "description": "[Public Preview] Indicate whether this schedule is paused or not.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/sql.SchedulePauseStatus", + "x-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "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-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" } }, @@ -9616,6 +10393,10 @@ "enum": [ "UNPAUSED", "PAUSED" + ], + "enumDescriptions": [ + "[PuPr]", + "[PuPr]" ] }, "sql.SpotInstancePolicy": { @@ -9643,8 +10424,11 @@ "description": "Type of endpoint.", "enum": [ "STORAGE_OPTIMIZED", - "STANDARD", - "STANDARD_ON_ORION" + "STANDARD" + ], + "enumDescriptions": [ + "[PuPr]", + "" ] }, "workspace.AzureKeyVaultSecretScopeMetadata": { @@ -9795,6 +10579,12 @@ "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresProject" } }, + "resources.PostgresSyncedTable": { + "type": "object", + "additionalProperties": { + "$ref": "#/$defs/github.com/databricks/cli/bundle/config/resources.PostgresSyncedTable" + } + }, "resources.QualityMonitor": { "type": "object", "additionalProperties": { From f6eaeaf3beef55826e24a5e69e796a9bfd8386d3 Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Thu, 4 Jun 2026 14:28:53 +0200 Subject: [PATCH 4/7] Use current jsonschema in VS Code to view databricks.yml --- .vscode/settings.json | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.vscode/settings.json b/.vscode/settings.json index a0f74f88ac1..8d7f9306352 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -22,5 +22,13 @@ "script": "shellscript", "script.prepare": "shellscript", "script.cleanup": "shellscript" + }, + "yaml.schemas": { + "./bundle/schema/jsonschema.json": [ + "databricks.yml", + "databricks.yaml", + "bundle.yml", + "bundle.yaml", + ] } } From d7ea0039fe35d8727ef9c89240d08091d4391be1 Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Thu, 4 Jun 2026 15:14:31 +0200 Subject: [PATCH 5/7] Drop DEVELOPMENT case from previewTag MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The DEVELOPMENT case in previewTag was dead code: extractAnnotations in parser.go already returns early for DEVELOPMENT-stage types/properties, so a DEVELOPMENT value never reaches assignAnnotation. If it ever did (e.g. via a hand-edited annotation file), the previous behavior would leak a [Development] marker into the public schema — exactly what we filter out elsewhere. The companion previewTagShort already returned "" for DEVELOPMENT; this restores consistency between the two. Co-authored-by: Isaac --- bundle/internal/schema/annotations.go | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index ab1dc4a2355..1f5cb373d09 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -224,7 +224,10 @@ func previewTagShort(launchStage string) string { // previewTag returns the human-readable launch-stage prefix to prepend to a // field's description. LaunchStage is preferred over Preview because it carries // the richer signal (Beta vs. Public Preview), falling back to the legacy -// Preview field when only that's available. +// Preview field when only that's available. DEVELOPMENT is intentionally not +// surfaced — those fields are filtered out at extraction time, so reaching +// this code path with DEVELOPMENT means something is wrong; the safe default +// is to emit no tag rather than leak a [Development] marker into the schema. func previewTag(launchStage, preview string) string { switch launchStage { case "PRIVATE_PREVIEW": @@ -233,8 +236,6 @@ func previewTag(launchStage, preview string) string { return "[Public Beta]" case "PUBLIC_PREVIEW": return "[Public Preview]" - case "DEVELOPMENT": - return "[Development]" } if preview == "PRIVATE" { return "[Private Preview]" From 5fd98258c859ada066895427cb5b1410922600de Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Thu, 4 Jun 2026 15:18:38 +0200 Subject: [PATCH 6/7] Map x-databricks-preview PUBLIC to Public Preview MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The legacy x-databricks-preview extension's PUBLIC value literally means "Public Preview" per the upstream source at universe/openapi/openapi/openapi.go: PrivatePreviewType: "PRIVATE" PublicPreviewType: "PUBLIC" // ← Public Preview, not GA GAPreviewType: "GA" func (pt PreviewType) IsPublicPreview() bool { return pt == PublicPreviewType } The CLI's annotation extractor was stripping PUBLIC in normalizePreview (treating it as a GA-equivalent default), losing the preview signal for any field that only carried the legacy extension. In practice the modern x-databricks-launch-stage is the primary source today, but PUBLIC could silently shadow real preview status if a spec entry has only the legacy field set. Fix: - bundle/internal/schema/parser.go: normalizePreview now drops only empty/UNKNOWN/GA values; PUBLIC and PRIVATE are preserved. - bundle/internal/schema/annotations.go: previewTag maps PUBLIC -> [Public Preview] alongside the existing PRIVATE -> [Private Preview] fallback. Launch stage still wins precedence when both are set, so a field with both PUBLIC and PUBLIC_PREVIEW only gets one [Public Preview] prefix. - prefixWithPreviewTag is hardened against double-tagging: if the description already starts with the tag, it's returned unchanged. - Unit tests cover the table of (launchStage, preview) combinations, the no-double-tag guarantee on the helper, and the assignAnnotation scenarios that exercise the new fallback. Test-only at the helper level so we don't assert against the same fact across multiple generated files. - Regenerated annotations_openapi.yml and both jsonschema files now carry x-databricks-preview: PUBLIC entries for fields tagged that way in the spec; their descriptions show [Public Preview] exactly once. Co-authored-by: Isaac --- bundle/internal/schema/annotations.go | 12 +- .../internal/schema/annotations_openapi.yml | 122 ++++++++++++++++++ bundle/internal/schema/annotations_test.go | 65 ++++++++++ bundle/internal/schema/parser.go | 10 +- bundle/schema/jsonschema.json | 54 ++++++++ bundle/schema/jsonschema_for_docs.json | 54 ++++++++ 6 files changed, 313 insertions(+), 4 deletions(-) diff --git a/bundle/internal/schema/annotations.go b/bundle/internal/schema/annotations.go index 1f5cb373d09..bb96c23f51d 100644 --- a/bundle/internal/schema/annotations.go +++ b/bundle/internal/schema/annotations.go @@ -237,16 +237,26 @@ func previewTag(launchStage, preview string) string { case "PUBLIC_PREVIEW": return "[Public Preview]" } - if preview == "PRIVATE" { + switch preview { + case "PRIVATE": return "[Private Preview]" + case "PUBLIC": + return "[Public Preview]" } return "" } +// prefixWithPreviewTag prepends the launch-stage tag to a description while +// guarding against double-tagging — if the description already starts with +// the tag (e.g. the annotation file was hand-edited, or two passes ran), +// the description is returned unchanged. func prefixWithPreviewTag(description, tag string) string { if description == "" { return tag } + if strings.HasPrefix(description, tag) { + return description + } return tag + " " + description } diff --git a/bundle/internal/schema/annotations_openapi.yml b/bundle/internal/schema/annotations_openapi.yml index 3f1569a570a..1e1be3edca3 100644 --- a/bundle/internal/schema/annotations_openapi.yml +++ b/bundle/internal/schema/annotations_openapi.yml @@ -111,6 +111,8 @@ github.com/databricks/cli/bundle/config/resources.App: "budget_policy_id": "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "compute_size": {} "compute_status": "x-databricks-field-behaviors_output_only": |- @@ -139,11 +141,15 @@ github.com/databricks/cli/bundle/config/resources.App: true "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "effective_usage_policy_id": "x-databricks-field-behaviors_output_only": |- true "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "effective_user_api_scopes": "description": |- The effective api scopes granted to the user access token. @@ -151,6 +157,8 @@ github.com/databricks/cli/bundle/config/resources.App: true "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "git_repository": "description": |- Git repository configuration for app deployments. When specified, deployments can @@ -169,11 +177,15 @@ github.com/databricks/cli/bundle/config/resources.App: true "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "oauth2_app_integration_id": "x-databricks-field-behaviors_output_only": |- true "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "pending_deployment": "description": |- The pending deployment of the app. A deployment is considered pending when it is being prepared @@ -202,6 +214,8 @@ github.com/databricks/cli/bundle/config/resources.App: "telemetry_export_destinations": "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "thumbnail_url": "description": |- The URL of the thumbnail image for the app. @@ -225,9 +239,13 @@ github.com/databricks/cli/bundle/config/resources.App: "usage_policy_id": "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "user_api_scopes": "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC github.com/databricks/cli/bundle/config/resources.Catalog: "comment": "description": |- @@ -514,6 +532,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: Custom tags associated with the instance. This field is only included on create and update responses. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "effective_capacity": "description": |- Deprecated. The sku of the instance; this field will always match the value of capacity. @@ -534,6 +554,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: true "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "effective_enable_pg_native_login": "description": |- Whether the instance has PG native password login enabled. @@ -590,6 +612,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: true "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "enable_pg_native_login": "description": |- Whether to enable PG native password login on the instance. Defaults to false. @@ -672,6 +696,8 @@ github.com/databricks/cli/bundle/config/resources.DatabaseInstance: The desired usage policy to associate with the instance. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC github.com/databricks/cli/bundle/config/resources.ExternalLocation: "comment": "description": |- @@ -725,6 +751,8 @@ github.com/databricks/cli/bundle/config/resources.Job: See `effective_budget_policy_id` for the budget policy used by this workload. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "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. @@ -889,6 +917,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: Budget policy of this pipeline. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "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. @@ -919,6 +949,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: Environment specification for this pipeline used to install dependencies. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "event_log": "description": |- Event log configuration for this pipeline @@ -940,6 +972,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: 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 + "x-databricks-preview": |- + PUBLIC "libraries": "description": |- Libraries or code needed by this deployment. @@ -966,6 +1000,8 @@ github.com/databricks/cli/bundle/config/resources.Pipeline: added to sys.path when executing Python sources during pipeline execution. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "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. @@ -1284,6 +1320,8 @@ github.com/databricks/cli/bundle/config/resources.VectorSearchEndpoint: The budget policy id to be applied "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "endpoint_type": "description": |- Type of endpoint @@ -1297,6 +1335,8 @@ github.com/databricks/cli/bundle/config/resources.VectorSearchEndpoint: Best-effort target; the system does not guarantee this QPS will be achieved. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "usage_policy_id": "description": |- The usage policy id to be applied once we've migrated to usage policies @@ -2618,6 +2658,8 @@ github.com/databricks/databricks-sdk-go/service/compute.Environment: 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 + "x-databricks-preview": |- + PUBLIC github.com/databricks/databricks-sdk-go/service/compute.GcpAttributes: "_": "description": |- @@ -3018,6 +3060,8 @@ github.com/databricks/databricks-sdk-go/service/database.NewPipelineSpec: Budget policy to set on the newly created pipeline. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "storage_catalog": "description": |- This field needs to be specified if the destination catalog is a managed postgres catalog. @@ -3482,11 +3526,15 @@ github.com/databricks/databricks-sdk-go/service/jobs.AlertTask: The number of subscriptions is limited to 100. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "warehouse_id": "description": |- The warehouse_id identifies the warehouse settings used by the alert task. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "workspace_path": "description": |- The workspace_path is the path to the alert file in the workspace. The path: @@ -3495,6 +3543,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.AlertTask: User has to select only one of alert_id or workspace_path to identify the alert. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber: "_": "description": |- @@ -3503,11 +3553,15 @@ github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber: "destination_id": "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "user_name": "description": |- A valid workspace email address. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC github.com/databricks/databricks-sdk-go/service/jobs.AuthenticationMethod: "_": "enum": @@ -3910,6 +3964,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.JobEmailNotifications: 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 + "x-databricks-preview": |- + PUBLIC "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. @@ -4624,6 +4680,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: when the `alert_task` field is present. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "clean_rooms_notebook_task": "description": |- The task runs a [clean rooms](https://docs.databricks.com/clean-rooms/index.html) notebook @@ -4633,6 +4691,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: Task level compute configuration. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "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. @@ -4723,6 +4783,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.Task: The task triggers a Power BI semantic model update when the `power_bi_task` field is present. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "python_wheel_task": "description": |- The task runs a Python wheel when the `python_wheel_task` field is present. @@ -4798,6 +4860,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.TaskEmailNotifications: 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 + "x-databricks-preview": |- + PUBLIC "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. @@ -4859,6 +4923,8 @@ github.com/databricks/databricks-sdk-go/service/jobs.WebhookNotifications: A maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "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. @@ -4972,11 +5038,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.ConnectorOptions: Jira specific options for ingestion "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "meta_ads_options": "description": |- Meta Marketing (Meta Ads) specific options for ingestion "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC "outlook_options": "description": |- Outlook specific options for ingestion @@ -5403,6 +5473,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "ingest_from_uc_foreign_catalog": "description": |- Immutable. If set to true, the pipeline will ingest tables from the @@ -5411,6 +5483,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin the UC foreign catalogs to ingest from. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "ingestion_gateway_id": "description": |- Identifier for the gateway that is used by this ingestion pipeline to communicate with the source database. @@ -5438,6 +5512,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin Top-level source configurations "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "source_type": "description": |- The type of the foreign source. @@ -5466,6 +5542,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin `sequence_by` to override this default. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "deletion_condition": "description": |- Specifies a SQL WHERE condition that specifies that the source row has been deleted. @@ -5477,6 +5555,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin handling of "hard deletes" where the source rows are physically removed from the table. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "hard_deletion_sync_min_interval_in_seconds": "description": |- Specifies the minimum interval (in seconds) between snapshots on primary keys @@ -5489,6 +5569,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefin This field is mutable and can be updated without triggering a full snapshot. "x-databricks-launch-stage": |- PUBLIC_BETA + "x-databricks-preview": |- + PUBLIC github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionWorkdayReportParameters: "incremental": "description": |- @@ -5975,6 +6057,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PipelineLibrary: This field cannot be used together with `notebook` or `file`. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "jar": "description": |- URI of the jar to be installed. Currently only DBFS is supported. @@ -6050,6 +6134,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig: Optional. The Postgres slot configuration to use for logical replication "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig: "_": "description": |- @@ -6059,11 +6145,15 @@ github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig: The name of the publication to use for the Postgres source "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "slot_name": "description": |- The name of the logical replication slot to use for the Postgres source "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC github.com/databricks/databricks-sdk-go/service/pipelines.ReportSpec: "destination_catalog": "description": |- @@ -6211,17 +6301,23 @@ github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig: Postgres-specific catalog-level configuration parameters "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "source_catalog": "description": |- Source catalog name "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig: "catalog": "description": |- Catalog-level source configuration parameters "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "google_ads_config": "x-databricks-launch-stage": |- PRIVATE_PREVIEW @@ -6284,6 +6380,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: If unspecified, auto full refresh is disabled. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "exclude_columns": "description": |- A list of column names to be excluded for the ingestion. @@ -6292,6 +6390,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: This field in mutually exclusive with `include_columns`. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "include_columns": "description": |- A list of column names to be included for the ingestion. @@ -6301,6 +6401,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: This field in mutually exclusive with `exclude_columns`. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "primary_keys": "description": |- The primary key of the table used to apply changes. @@ -6311,6 +6413,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: Configurations that are only applicable for query-based ingestion connectors. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "row_filter": "description": |- (Optional, Immutable) The row filter condition to be applied to the table. @@ -6318,6 +6422,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: It must be in DBSQL format. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "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 @@ -6330,6 +6436,8 @@ github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfig: The SCD type to use to ingest the table. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "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. @@ -6620,6 +6728,8 @@ github.com/databricks/databricks-sdk-go/service/serving.AiGatewayConfig: Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "inference_table_config": "description": |- Configuration for payload logging using inference tables. @@ -7197,6 +7307,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput: maintains fixed capacity at provisioned_model_units. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "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**. @@ -7212,6 +7324,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput: ARN of the instance profile that the served entity uses to access AWS resources. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "max_provisioned_concurrency": "description": |- The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified. @@ -7232,6 +7346,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedEntityInput: The number of model units provisioned. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "scale_to_zero_enabled": "description": |- Whether the compute resources for the served entity should scale down to zero. @@ -7249,6 +7365,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput: maintains fixed capacity at provisioned_model_units. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "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}}"}` @@ -7257,6 +7375,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput: ARN of the instance profile that the served entity uses to access AWS resources. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "max_provisioned_concurrency": "description": |- The maximum provisioned concurrency that the endpoint can scale up to. Do not use if workload_size is specified. @@ -7279,6 +7399,8 @@ github.com/databricks/databricks-sdk-go/service/serving.ServedModelInput: The number of model units provisioned. "x-databricks-launch-stage": |- PUBLIC_PREVIEW + "x-databricks-preview": |- + PUBLIC "scale_to_zero_enabled": "description": |- Whether the compute resources for the served entity should scale down to zero. diff --git a/bundle/internal/schema/annotations_test.go b/bundle/internal/schema/annotations_test.go index b625c624014..97a0ca34190 100644 --- a/bundle/internal/schema/annotations_test.go +++ b/bundle/internal/schema/annotations_test.go @@ -94,6 +94,71 @@ func TestAssignAnnotationLaunchStage(t *testing.T) { }) assert.Equal(t, "Type of endpoint.", s.Description) }) + + t.Run("legacy preview PUBLIC maps to Public Preview", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "Legacy-tagged field.", + Preview: "PUBLIC", + }) + assert.Equal(t, "[Public Preview] Legacy-tagged field.", s.Description) + }) + + t.Run("PUBLIC_PREVIEW launch stage with PUBLIC preview tags once, not twice", func(t *testing.T) { + s := &jsonschema.Schema{} + assignAnnotation(s, annotation.Descriptor{ + Description: "Doubly-tagged field.", + Preview: "PUBLIC", + LaunchStage: "PUBLIC_PREVIEW", + }) + assert.Equal(t, "[Public Preview] Doubly-tagged field.", s.Description) + }) +} + +func TestPreviewTag(t *testing.T) { + tests := []struct { + name string + launchStage string + preview string + want string + }{ + {"launch stage PUBLIC_PREVIEW wins", "PUBLIC_PREVIEW", "", "[Public Preview]"}, + {"launch stage PUBLIC_BETA wins", "PUBLIC_BETA", "", "[Public Beta]"}, + {"launch stage PRIVATE_PREVIEW wins", "PRIVATE_PREVIEW", "", "[Private Preview]"}, + {"launch stage beats preview", "PUBLIC_BETA", "PRIVATE", "[Public Beta]"}, + {"legacy PUBLIC maps to Public Preview", "", "PUBLIC", "[Public Preview]"}, + {"legacy PRIVATE maps to Private Preview", "", "PRIVATE", "[Private Preview]"}, + {"GA-equivalent values yield no tag", "", "GA", ""}, + {"unknown DEVELOPMENT yields no tag (filtered upstream)", "DEVELOPMENT", "", ""}, + {"both empty yields no tag", "", "", ""}, + } + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + assert.Equal(t, tc.want, previewTag(tc.launchStage, tc.preview)) + }) + } +} + +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) { + // Cross-tag mismatches should still get the new tag — the guard is + // only for the exact same tag, not for any preview tag. + got := prefixWithPreviewTag("[Private Preview] foo", "[Public Preview]") + assert.Equal(t, "[Public Preview] [Private Preview] foo", got) + }) } func TestBuildEnumDescriptions(t *testing.T) { diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 766daa254ca..3d2dce798c3 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -124,10 +124,14 @@ func isOutputOnly(s jsonschema.Schema) *bool { return &res } -// normalizePreview drops PUBLIC (the GA value for x-databricks-preview) so it -// isn't persisted in the annotation file. PRIVATE is preserved. +// normalizePreview drops the values of x-databricks-preview that carry no +// information worth persisting. Per the upstream source-of-truth at +// universe/openapi/openapi/openapi.go, the legal non-default values are +// PRIVATE (Private Preview), PUBLIC (Public Preview), and GA. UNKNOWN / +// empty / GA are the absence-of-signal cases. func normalizePreview(preview string) string { - if preview == "PUBLIC" { + switch preview { + case "", "UNKNOWN", "GA": return "" } return preview diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json index 71a6770c744..df6e2e80aff 100644 --- a/bundle/schema/jsonschema.json +++ b/bundle/schema/jsonschema.json @@ -164,6 +164,7 @@ "budget_policy_id": { "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "compute_size": { @@ -212,16 +213,19 @@ "telemetry_export_destinations": { "description": "[Public Preview]", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "usage_policy_id": { "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "user_api_scopes": { "description": "[Public Preview]", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, @@ -678,6 +682,7 @@ "custom_tags": { "description": "[Public Beta] Custom tags associated with the instance. This field is only included on create and update responses.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.CustomTag", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" }, "enable_pg_native_login": { @@ -725,6 +730,7 @@ "usage_policy_id": { "description": "[Public Beta] The desired usage policy to associate with the instance.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" } }, @@ -802,6 +808,7 @@ "budget_policy_id": { "description": "[Public Preview] The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "continuous": { @@ -1243,6 +1250,7 @@ "budget_policy_id": { "description": "[Public Preview] Budget policy of this pipeline.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "catalog": { @@ -1276,6 +1284,7 @@ "environment": { "description": "[Public Preview] Environment specification for this pipeline used to install dependencies.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "event_log": { @@ -1300,6 +1309,7 @@ "ingestion_definition": { "description": "[Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "libraries": { @@ -1335,6 +1345,7 @@ "root_path": { "description": "[Public Preview] Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "run_as": { @@ -2089,6 +2100,7 @@ "budget_policy_id": { "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "endpoint_type": { @@ -2106,6 +2118,7 @@ "target_qps": { "description": "[Public Preview]", "$ref": "#/$defs/int64", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "usage_policy_id": { @@ -4926,6 +4939,7 @@ "java_dependencies": { "description": "[Public Preview]", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, @@ -5536,6 +5550,7 @@ "budget_policy_id": { "description": "[Public Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" }, "storage_catalog": { @@ -5895,16 +5910,19 @@ "subscribers": { "description": "[Public Beta] The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" }, "warehouse_id": { "description": "[Public Beta] The warehouse_id identifies the warehouse settings used by the alert task.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" }, "workspace_path": { "description": "[Public Beta] The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" } }, @@ -5925,11 +5943,13 @@ "destination_id": { "description": "[Public Beta]", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" }, "user_name": { "description": "[Public Beta] A valid workspace email address.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" } }, @@ -6635,6 +6655,7 @@ "on_streaming_backlog_exceeded": { "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "on_success": { @@ -7816,6 +7837,7 @@ "alert_task": { "description": "[Public Beta] The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" }, "clean_rooms_notebook_task": { @@ -7825,6 +7847,7 @@ "compute": { "description": "[Public Beta] Task level compute configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" }, "condition_task": { @@ -7932,6 +7955,7 @@ "power_bi_task": { "description": "[Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "python_wheel_task": { @@ -8043,6 +8067,7 @@ "on_streaming_backlog_exceeded": { "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "on_success": { @@ -8176,6 +8201,7 @@ "on_streaming_backlog_exceeded": { "description": "[Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "on_success": { @@ -8370,11 +8396,13 @@ "jira_options": { "description": "[Public Beta] Jira specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" }, "meta_ads_options": { "description": "[Public Beta] Meta Marketing (Meta Ads) specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" }, "outlook_options": { @@ -9002,11 +9030,13 @@ "full_refresh_window": { "description": "[Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "ingest_from_uc_foreign_catalog": { "description": "[Public Preview] Immutable. If set to true, the pipeline will ingest tables from the\nUC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.\nThe `source_catalog` fields in objects of IngestionConfig are interpreted as\nthe UC foreign catalogs to ingest from.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "ingestion_gateway_id": { @@ -9029,6 +9059,7 @@ "source_configurations": { "description": "[Public Preview] Top-level source configurations", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "table_configuration": { @@ -9054,16 +9085,19 @@ "cursor_columns": { "description": "[Public Preview] The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "deletion_condition": { "description": "[Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted.\nThis is sometimes referred to as \"soft-deletes\".\nFor example: \"Operation = 'DELETE'\" or \"is_deleted = true\".\nThis field is orthogonal to `hard_deletion_sync_interval_in_seconds`,\none for soft-deletes and the other for hard-deletes.\nSee also the hard_deletion_sync_min_interval_in_seconds field for\nhandling of \"hard deletes\" where the source rows are physically removed from the table.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "hard_deletion_sync_min_interval_in_seconds": { "description": "[Public Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", "$ref": "#/$defs/int64", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA" } }, @@ -9669,6 +9703,7 @@ "glob": { "description": "[Public Preview] The unified field to include source codes.\nEach entry can be a notebook path, a file path, or a folder path that ends `/**`.\nThis field cannot be used together with `notebook` or `file`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "jar": { @@ -9778,6 +9813,7 @@ "slot_config": { "description": "[Public Preview] Optional. The Postgres slot configuration to use for logical replication", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, @@ -9798,11 +9834,13 @@ "publication_name": { "description": "[Public Preview] The name of the publication to use for the Postgres source", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "slot_name": { "description": "[Public Preview] The name of the logical replication slot to use for the Postgres source", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, @@ -10050,11 +10088,13 @@ "postgres": { "description": "[Public Preview] Postgres-specific catalog-level configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "source_catalog": { "description": "[Public Preview] Source catalog name", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" } }, @@ -10074,6 +10114,7 @@ "catalog": { "description": "[Public Preview] Catalog-level source configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "google_ads_config": { @@ -10159,16 +10200,19 @@ "auto_full_refresh_policy": { "description": "[Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "exclude_columns": { "description": "[Public Preview] A list of column names to be excluded for the ingestion.\nWhen not specified, include_columns fully controls what columns to be ingested.\nWhen specified, all other columns including future ones will be automatically included for ingestion.\nThis field in mutually exclusive with `include_columns`.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "include_columns": { "description": "[Public Preview] A list of column names to be included for the ingestion.\nWhen not specified, all columns except ones in exclude_columns will be included. Future\ncolumns will be automatically included.\nWhen specified, all other future columns will be automatically excluded from ingestion.\nThis field in mutually exclusive with `exclude_columns`.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "primary_keys": { @@ -10179,11 +10223,13 @@ "query_based_connector_config": { "description": "[Public Preview] Configurations that are only applicable for query-based ingestion connectors.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "row_filter": { "description": "[Public Preview] (Optional, Immutable) The row filter condition to be applied to the table.\nIt must not contain the WHERE keyword, only the actual filter condition.\nIt must be in DBSQL format.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "salesforce_include_formula_fields": { @@ -10196,6 +10242,7 @@ "scd_type": { "description": "[Public Preview] The SCD type to use to ingest the table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "sequence_by": { @@ -10593,6 +10640,7 @@ "guardrails": { "description": "[Public Preview] Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "inference_table_config": { @@ -11518,6 +11566,7 @@ "burst_scaling_enabled": { "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "entity_name": { @@ -11538,6 +11587,7 @@ "instance_profile_arn": { "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "max_provisioned_concurrency": { @@ -11563,6 +11613,7 @@ "provisioned_model_units": { "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { @@ -11594,6 +11645,7 @@ "burst_scaling_enabled": { "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "environment_vars": { @@ -11603,6 +11655,7 @@ "instance_profile_arn": { "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "max_provisioned_concurrency": { @@ -11634,6 +11687,7 @@ "provisioned_model_units": { "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW" }, "scale_to_zero_enabled": { diff --git a/bundle/schema/jsonschema_for_docs.json b/bundle/schema/jsonschema_for_docs.json index e43a5e70520..6d6484fe791 100644 --- a/bundle/schema/jsonschema_for_docs.json +++ b/bundle/schema/jsonschema_for_docs.json @@ -111,6 +111,7 @@ "budget_policy_id": { "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.243.0" }, @@ -171,18 +172,21 @@ "telemetry_export_destinations": { "description": "[Public Preview]", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/apps.TelemetryExportDestination", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.294.0" }, "usage_policy_id": { "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.283.0" }, "user_api_scopes": { "description": "[Public Preview]", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.246.0" } @@ -650,6 +654,7 @@ "custom_tags": { "description": "[Public Beta] Custom tags associated with the instance. This field is only included on create and update responses.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/database.CustomTag", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.273.0" }, @@ -707,6 +712,7 @@ "usage_policy_id": { "description": "[Public Beta] The desired usage policy to associate with the instance.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.273.0" } @@ -781,6 +787,7 @@ "budget_policy_id": { "description": "[Public Preview] The id of the user specified budget policy to use for this job.\nIf not specified, a default budget policy may be applied when creating or modifying the job.\nSee `effective_budget_policy_id` for the budget policy used by this workload.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.231.0" }, @@ -1203,6 +1210,7 @@ "budget_policy_id": { "description": "[Public Preview] Budget policy of this pipeline.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" }, @@ -1244,6 +1252,7 @@ "environment": { "description": "[Public Preview] Environment specification for this pipeline used to install dependencies.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PipelinesEnvironment", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.257.0" }, @@ -1273,6 +1282,7 @@ "ingestion_definition": { "description": "[Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinition", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, @@ -1316,6 +1326,7 @@ "root_path": { "description": "[Public Preview] Root path for this pipeline.\nThis is used as the root directory when editing the pipeline in the Databricks user interface and it is\nadded to sys.path when executing Python sources during pipeline execution.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.253.0" }, @@ -2077,6 +2088,7 @@ "budget_policy_id": { "description": "[Public Preview]", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.298.0" }, @@ -2099,6 +2111,7 @@ "target_qps": { "description": "[Public Preview]", "$ref": "#/$defs/int64", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.299.2" }, @@ -4441,6 +4454,7 @@ "java_dependencies": { "description": "[Public Preview]", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.271.0" } @@ -4909,6 +4923,7 @@ "budget_policy_id": { "description": "[Public Beta] Budget policy to set on the newly created pipeline.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.279.0" }, @@ -5171,18 +5186,21 @@ "subscribers": { "description": "[Public Beta] The subscribers receive alert evaluation result notifications after the alert task is completed.\nThe number of subscriptions is limited to 100.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.AlertTaskSubscriber", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, "warehouse_id": { "description": "[Public Beta] The warehouse_id identifies the warehouse settings used by the alert task.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, "workspace_path": { "description": "[Public Beta] The workspace_path is the path to the alert file in the workspace. The path:\n* must start with \"/Workspace\"\n* must be a normalized path.\nUser has to select only one of alert_id or workspace_path to identify the alert.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" } @@ -5196,12 +5214,14 @@ "destination_id": { "description": "[Public Beta]", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, "user_name": { "description": "[Public Beta] A valid workspace email address.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" } @@ -5768,6 +5788,7 @@ "on_streaming_backlog_exceeded": { "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, @@ -6702,6 +6723,7 @@ "alert_task": { "description": "[Public Beta] The task evaluates a Databricks alert and sends notifications to subscribers\nwhen the `alert_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.AlertTask", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.296.0" }, @@ -6713,6 +6735,7 @@ "compute": { "description": "[Public Beta] Task level compute configuration.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.Compute", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.288.0" }, @@ -6844,6 +6867,7 @@ "power_bi_task": { "description": "[Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/jobs.PowerBiTask", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.248.0" }, @@ -6957,6 +6981,7 @@ "on_streaming_backlog_exceeded": { "description": "[Public Preview] A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, @@ -7064,6 +7089,7 @@ "on_streaming_backlog_exceeded": { "description": "[Public Preview] An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\nStreaming backlog thresholds can be set in the `health` field using the following metrics: `STREAMING_BACKLOG_BYTES`, `STREAMING_BACKLOG_RECORDS`, `STREAMING_BACKLOG_SECONDS`, or `STREAMING_BACKLOG_FILES`.\nAlerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.\nA maximum of 3 destinations can be specified for the `on_streaming_backlog_exceeded` property.", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/jobs.Webhook", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, @@ -7207,12 +7233,14 @@ "jira_options": { "description": "[Public Beta] Jira specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.JiraConnectorOptions", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, "meta_ads_options": { "description": "[Public Beta] Meta Marketing (Meta Ads) specific options for ingestion", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.MetaMarketingOptions", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.299.2" }, @@ -7738,12 +7766,14 @@ "full_refresh_window": { "description": "[Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.OperationTimeWindow", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.285.0" }, "ingest_from_uc_foreign_catalog": { "description": "[Public Preview] Immutable. If set to true, the pipeline will ingest tables from the\nUC foreign catalogs directly without the need to specify a UC connection or ingestion gateway.\nThe `source_catalog` fields in objects of IngestionConfig are interpreted as\nthe UC foreign catalogs to ingest from.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.279.0" }, @@ -7770,6 +7800,7 @@ "source_configurations": { "description": "[Public Preview] Top-level source configurations", "$ref": "#/$defs/slice/github.com/databricks/databricks-sdk-go/service/pipelines.SourceConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" }, @@ -7789,18 +7820,21 @@ "cursor_columns": { "description": "[Public Preview] The names of the monotonically increasing columns in the source table that are used to enable\nthe table to be read and ingested incrementally through structured streaming.\nThe columns are allowed to have repeated values but have to be non-decreasing.\nIf the source data is merged into the destination (e.g., using SCD Type 1 or Type 2), these\ncolumns will implicitly define the `sequence_by` behavior. You can still explicitly set\n`sequence_by` to override this default.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.264.0" }, "deletion_condition": { "description": "[Public Preview] Specifies a SQL WHERE condition that specifies that the source row has been deleted.\nThis is sometimes referred to as \"soft-deletes\".\nFor example: \"Operation = 'DELETE'\" or \"is_deleted = true\".\nThis field is orthogonal to `hard_deletion_sync_interval_in_seconds`,\none for soft-deletes and the other for hard-deletes.\nSee also the hard_deletion_sync_min_interval_in_seconds field for\nhandling of \"hard deletes\" where the source rows are physically removed from the table.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.264.0" }, "hard_deletion_sync_min_interval_in_seconds": { "description": "[Public Beta] Specifies the minimum interval (in seconds) between snapshots on primary keys\nfor detecting and synchronizing hard deletions—i.e., rows that have been\nphysically removed from the source table.\nThis interval acts as a lower bound. If ingestion runs less frequently than\nthis value, hard deletion synchronization will align with the actual ingestion\nfrequency instead of happening more often.\nIf not set, hard deletion synchronization via snapshots is disabled.\nThis field is mutable and can be updated without triggering a full snapshot.", "$ref": "#/$defs/int64", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_BETA", "x-since-version": "v0.264.0" } @@ -8319,6 +8353,7 @@ "glob": { "description": "[Public Preview] The unified field to include source codes.\nEach entry can be a notebook path, a file path, or a folder path that ends `/**`.\nThis field cannot be used together with `notebook` or `file`.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PathPattern", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.252.0" }, @@ -8405,6 +8440,7 @@ "slot_config": { "description": "[Public Preview] Optional. The Postgres slot configuration to use for logical replication", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresSlotConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" } @@ -8418,12 +8454,14 @@ "publication_name": { "description": "[Public Preview] The name of the publication to use for the Postgres source", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" }, "slot_name": { "description": "[Public Preview] The name of the logical replication slot to use for the Postgres source", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" } @@ -8628,12 +8666,14 @@ "postgres": { "description": "[Public Preview] Postgres-specific catalog-level configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.PostgresCatalogConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" }, "source_catalog": { "description": "[Public Preview] Source catalog name", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" } @@ -8646,6 +8686,7 @@ "catalog": { "description": "[Public Preview] Catalog-level source configuration parameters", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.SourceCatalogConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.267.0" }, @@ -8725,18 +8766,21 @@ "auto_full_refresh_policy": { "description": "[Public Preview] (Optional, Mutable) Policy for auto full refresh, if enabled pipeline will automatically try\nto fix issues by doing a full refresh on the table in the retry run. auto_full_refresh_policy\nin table configuration will override the above level auto_full_refresh_policy.\nFor example,\n{\n\"auto_full_refresh_policy\": {\n\"enabled\": true,\n\"min_interval_hours\": 23,\n}\n}\nIf unspecified, auto full refresh is disabled.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.AutoFullRefreshPolicy", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.285.0" }, "exclude_columns": { "description": "[Public Preview] A list of column names to be excluded for the ingestion.\nWhen not specified, include_columns fully controls what columns to be ingested.\nWhen specified, all other columns including future ones will be automatically included for ingestion.\nThis field in mutually exclusive with `include_columns`.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.251.0" }, "include_columns": { "description": "[Public Preview] A list of column names to be included for the ingestion.\nWhen not specified, all columns except ones in exclude_columns will be included. Future\ncolumns will be automatically included.\nWhen specified, all other future columns will be automatically excluded from ingestion.\nThis field in mutually exclusive with `exclude_columns`.", "$ref": "#/$defs/slice/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.251.0" }, @@ -8749,12 +8793,14 @@ "query_based_connector_config": { "description": "[Public Preview] Configurations that are only applicable for query-based ingestion connectors.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.264.0" }, "row_filter": { "description": "[Public Preview] (Optional, Immutable) The row filter condition to be applied to the table.\nIt must not contain the WHERE keyword, only the actual filter condition.\nIt must be in DBSQL format.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.283.0" }, @@ -8769,6 +8815,7 @@ "scd_type": { "description": "[Public Preview] The SCD type to use to ingest the table.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/pipelines.TableSpecificConfigScdType", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, @@ -9082,6 +9129,7 @@ "guardrails": { "description": "[Public Preview] Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses.", "$ref": "#/$defs/github.com/databricks/databricks-sdk-go/service/serving.AiGatewayGuardrails", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.230.0" }, @@ -9843,6 +9891,7 @@ "burst_scaling_enabled": { "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.288.0" }, @@ -9868,6 +9917,7 @@ "instance_profile_arn": { "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, @@ -9899,6 +9949,7 @@ "provisioned_model_units": { "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.252.0" }, @@ -9926,6 +9977,7 @@ "burst_scaling_enabled": { "description": "[Public Preview] Whether burst scaling is enabled. When enabled (default), the endpoint can automatically\nscale up beyond provisioned capacity to handle traffic spikes. When disabled, the endpoint\nmaintains fixed capacity at provisioned_model_units.", "$ref": "#/$defs/bool", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.288.0" }, @@ -9937,6 +9989,7 @@ "instance_profile_arn": { "description": "[Public Preview] ARN of the instance profile that the served entity uses to access AWS resources.", "$ref": "#/$defs/string", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.229.0" }, @@ -9976,6 +10029,7 @@ "provisioned_model_units": { "description": "[Public Preview] The number of model units provisioned.", "$ref": "#/$defs/int64", + "x-databricks-preview": "PUBLIC", "x-databricks-launch-stage": "PUBLIC_PREVIEW", "x-since-version": "v0.252.0" }, From a4089fda9f5c41b139f0f1ac3869e3c821ba7a04 Mon Sep 17 00:00:00 2001 From: Jan Rose Date: Mon, 8 Jun 2026 11:59:34 +0200 Subject: [PATCH 7/7] Address review findings: regenerate docs/pydabs, align previewTag MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Follow-up to the origin/main merge, addressing review feedback on stale generated artifacts and previewTag drift. - bundle/docsgen/main.go: previewTag had drifted from the schema-side copy in bundle/internal/schema/annotations.go — it still mapped DEVELOPMENT to [Development] and lacked the legacy x-databricks-preview PUBLIC -> [Public Preview] fallback. Aligned the two and noted the keep-in-sync invariant. - bundle/docsgen/output/{reference,resources}.md: regenerated. The docsgen launch-stage prefixes added on this branch had never been applied to the committed docs; they now match jsonschema.json (e.g. budget_policy_id is tagged [Public Preview], no [Development] markers leak). - python/databricks/bundles/**: regenerated via pydabs-codegen, which reads bundle/schema/jsonschema.json. Picks up the launch-stage prefixes and drops the DEVELOPMENT enum values filtered from the schema (catalog.Privilege loses CREATE_FEATURE/READ_FEATURE/etc.; pipelines.TransformerFormat loses AVRO/PROTOBUF), keeping the Python models consistent with the Go schema. - bundle/internal/schema/parser.go: defer creating the per-type annotation map until after the DEVELOPMENT early-return, so a DEVELOPMENT root type no longer leaves an empty package entry in annotations_openapi.yml. Co-authored-by: Isaac --- bundle/docsgen/main.go | 14 +- bundle/docsgen/output/reference.md | 10 +- bundle/docsgen/output/resources.md | 642 +++++++++--------- bundle/internal/schema/parser.go | 4 +- .../bundles/catalogs/_models/privilege.py | 28 - .../bundles/jobs/_models/alert_task.py | 16 +- .../jobs/_models/alert_task_subscriber.py | 10 +- .../bundles/jobs/_models/compute.py | 4 +- .../bundles/jobs/_models/compute_config.py | 12 +- .../bundles/jobs/_models/dashboard_task.py | 4 +- .../bundles/jobs/_models/dbt_platform_task.py | 8 +- .../bundles/jobs/_models/environment.py | 6 + .../bundles/jobs/_models/gcp_attributes.py | 4 +- .../jobs/_models/gen_ai_compute_task.py | 34 +- .../jobs/_models/hardware_accelerator_type.py | 3 +- python/databricks/bundles/jobs/_models/job.py | 8 +- .../jobs/_models/job_email_notifications.py | 4 +- .../bundles/jobs/_models/job_run_as.py | 4 +- .../_models/model_trigger_configuration.py | 20 +- .../bundles/jobs/_models/power_bi_model.py | 20 +- .../bundles/jobs/_models/power_bi_table.py | 16 +- .../bundles/jobs/_models/power_bi_task.py | 20 +- .../databricks/bundles/jobs/_models/task.py | 24 +- .../jobs/_models/task_email_notifications.py | 4 +- .../bundles/jobs/_models/trigger_settings.py | 4 + .../jobs/_models/webhook_notifications.py | 4 +- .../_models/auto_full_refresh_policy.py | 8 +- .../_models/confluence_connector_options.py | 4 +- .../_models/connection_parameters.py | 4 +- .../pipelines/_models/connector_options.py | 44 +- .../pipelines/_models/data_staging_options.py | 12 +- .../bundles/pipelines/_models/file_filter.py | 12 +- .../_models/file_ingestion_options.py | 54 +- .../file_ingestion_options_file_format.py | 5 +- .../pipelines/_models/gcp_attributes.py | 4 +- .../pipelines/_models/google_ads_config.py | 4 +- .../pipelines/_models/google_ads_options.py | 12 +- .../pipelines/_models/google_drive_options.py | 16 +- ..._drive_options_google_drive_entity_type.py | 6 +- .../pipelines/_models/ingestion_config.py | 12 +- .../ingestion_gateway_pipeline_definition.py | 24 +- .../_models/ingestion_pipeline_definition.py | 40 +- ...fic_config_query_based_connector_config.py | 12 +- ...ne_definition_workday_report_parameters.py | 12 +- ...rkday_report_parameters_query_key_value.py | 8 +- .../_models/jira_connector_options.py | 4 +- .../pipelines/_models/kafka_options.py | 8 +- .../_models/meta_marketing_options.py | 32 +- .../_models/operation_time_window.py | 12 +- .../pipelines/_models/outlook_options.py | 40 +- .../bundles/pipelines/_models/path_pattern.py | 4 +- .../bundles/pipelines/_models/pipeline.py | 28 +- .../pipelines/_models/pipeline_library.py | 12 +- .../_models/pipelines_environment.py | 8 +- .../_models/postgres_catalog_config.py | 4 +- .../pipelines/_models/postgres_slot_config.py | 8 +- .../bundles/pipelines/_models/report_spec.py | 20 +- .../pipelines/_models/restart_window.py | 12 +- .../bundles/pipelines/_models/schema_spec.py | 24 +- .../pipelines/_models/sharepoint_options.py | 12 +- ...arepoint_options_sharepoint_entity_type.py | 11 +- .../pipelines/_models/smartsheet_options.py | 4 +- .../_models/source_catalog_config.py | 8 +- .../pipelines/_models/source_config.py | 8 +- .../bundles/pipelines/_models/table_spec.py | 32 +- .../_models/table_specific_config.py | 40 +- .../pipelines/_models/tik_tok_ads_options.py | 28 +- .../pipelines/_models/transformer_format.py | 6 +- .../_models/zendesk_support_options.py | 4 +- .../bundles/schemas/_models/privilege.py | 28 - .../bundles/volumes/_models/privilege.py | 28 - 71 files changed, 829 insertions(+), 816 deletions(-) diff --git a/bundle/docsgen/main.go b/bundle/docsgen/main.go index b8bf40028c8..f1e12bba560 100644 --- a/bundle/docsgen/main.go +++ b/bundle/docsgen/main.go @@ -168,7 +168,12 @@ func assignAnnotation(s *jsonschema.Schema, a annotation.Descriptor) { // previewTag returns the human-readable launch-stage prefix to prepend to a // field's description. LaunchStage is preferred over Preview because it carries // the richer signal (Beta vs. Public Preview), falling back to the legacy -// Preview field when only that's available. +// Preview field when only that's available. DEVELOPMENT is intentionally not +// surfaced — those fields are filtered out at extraction time, so reaching +// this code path with DEVELOPMENT means something is wrong; the safe default +// is to emit no tag rather than leak a [Development] marker into the docs. +// +// Keep this in sync with previewTag in bundle/internal/schema/annotations.go. func previewTag(launchStage, preview string) string { switch launchStage { case "PRIVATE_PREVIEW": @@ -177,11 +182,12 @@ func previewTag(launchStage, preview string) string { return "[Public Beta]" case "PUBLIC_PREVIEW": return "[Public Preview]" - case "DEVELOPMENT": - return "[Development]" } - if preview == "PRIVATE" { + switch preview { + case "PRIVATE": return "[Private Preview]" + case "PUBLIC": + return "[Public Preview]" } return "" } diff --git a/bundle/docsgen/output/reference.md b/bundle/docsgen/output/reference.md index 16b7020cecd..c4d12a84387 100644 --- a/bundle/docsgen/output/reference.md +++ b/bundle/docsgen/output/reference.md @@ -1,7 +1,7 @@ --- description: 'Configuration reference for databricks.yml' last_update: - date: 2026-06-03 + date: 2026-06-08 --- @@ -2018,6 +2018,10 @@ postgres_projects: - String - +- - `purge_on_delete` + - Boolean + - + ::: @@ -4565,6 +4569,10 @@ postgres_projects: - String - +- - `purge_on_delete` + - Boolean + - + ::: diff --git a/bundle/docsgen/output/resources.md b/bundle/docsgen/output/resources.md index e4f902e6146..efd62d48d77 100644 --- a/bundle/docsgen/output/resources.md +++ b/bundle/docsgen/output/resources.md @@ -1,7 +1,7 @@ --- description: 'Learn about resources supported by Declarative Automation Bundles and how to configure them.' last_update: - date: 2026-06-03 + date: 2026-06-08 --- @@ -145,19 +145,19 @@ alerts: - - `custom_description` - String - - + - [Public Preview] - - `custom_summary` - String - - + - [Public Preview] - - `display_name` - String - - + - [Public Preview] - - `evaluation` - Map - - See [\_](#alertsnameevaluation). + - [Public Preview]. See [\_](#alertsnameevaluation). - - `file_path` - String @@ -169,7 +169,7 @@ alerts: - - `parent_path` - String - - + - [Public Preview] - - `permissions` - Sequence @@ -177,11 +177,11 @@ alerts: - - `query_text` - String - - + - [Public Preview] - - `run_as` - Map - - See [\_](#alertsnamerun_as). + - [Public Preview]. See [\_](#alertsnamerun_as). - - `run_as_user_name` - String @@ -189,11 +189,11 @@ alerts: - - `schedule` - Map - - See [\_](#alertsnameschedule). + - [Public Preview]. See [\_](#alertsnameschedule). - - `warehouse_id` - String - - + - [Public Preview] ::: @@ -202,7 +202,7 @@ alerts: **`Type: Map`** - +[Public Preview] @@ -214,23 +214,23 @@ alerts: - - `comparison_operator` - String - - Operator used for comparison in alert evaluation. + - [Public Preview] Operator used for comparison in alert evaluation. - - `empty_result_state` - String - - Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. + - [Public Preview] Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. - - `notification` - Map - - User or Notification Destination to notify when alert is triggered. See [\_](#alertsnameevaluationnotification). + - [Public Preview] User or Notification Destination to notify when alert is triggered. See [\_](#alertsnameevaluationnotification). - - `source` - Map - - Source column from result to use to evaluate alert. See [\_](#alertsnameevaluationsource). + - [Public Preview] Source column from result to use to evaluate alert. See [\_](#alertsnameevaluationsource). - - `threshold` - Map - - Threshold to user for alert evaluation, can be a column or a value. See [\_](#alertsnameevaluationthreshold). + - [Public Preview] Threshold to user for alert evaluation, can be a column or a value. See [\_](#alertsnameevaluationthreshold). ::: @@ -239,7 +239,7 @@ alerts: **`Type: Map`** -User or Notification Destination to notify when alert is triggered. +[Public Preview] User or Notification Destination to notify when alert is triggered. @@ -251,15 +251,15 @@ User or Notification Destination to notify when alert is triggered. - - `notify_on_ok` - Boolean - - Whether to notify alert subscribers when alert returns back to normal. + - [Public Preview] Whether to notify alert subscribers when alert returns back to normal. - - `retrigger_seconds` - Integer - - 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. + - [Public Preview] 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` - Sequence - - See [\_](#alertsnameevaluationnotificationsubscriptions). + - [Public Preview]. See [\_](#alertsnameevaluationnotificationsubscriptions). ::: @@ -268,7 +268,7 @@ User or Notification Destination to notify when alert is triggered. **`Type: Sequence`** - +[Public Preview] @@ -280,11 +280,11 @@ User or Notification Destination to notify when alert is triggered. - - `destination_id` - String - - + - [Public Preview] - - `user_email` - String - - + - [Public Preview] ::: @@ -293,7 +293,7 @@ User or Notification Destination to notify when alert is triggered. **`Type: Map`** -Source column from result to use to evaluate alert +[Public Preview] Source column from result to use to evaluate alert @@ -305,15 +305,15 @@ Source column from result to use to evaluate alert - - `aggregation` - String - - + - [Public Preview] - - `display` - String - - + - [Public Preview] - - `name` - String - - + - [Public Preview] ::: @@ -322,7 +322,7 @@ Source column from result to use to evaluate alert **`Type: Map`** -Threshold to user for alert evaluation, can be a column or a value. +[Public Preview] Threshold to user for alert evaluation, can be a column or a value. @@ -334,11 +334,11 @@ Threshold to user for alert evaluation, can be a column or a value. - - `column` - Map - - See [\_](#alertsnameevaluationthresholdcolumn). + - [Public Preview]. See [\_](#alertsnameevaluationthresholdcolumn). - - `value` - Map - - See [\_](#alertsnameevaluationthresholdvalue). + - [Public Preview]. See [\_](#alertsnameevaluationthresholdvalue). ::: @@ -347,7 +347,7 @@ Threshold to user for alert evaluation, can be a column or a value. **`Type: Map`** - +[Public Preview] @@ -359,15 +359,15 @@ Threshold to user for alert evaluation, can be a column or a value. - - `aggregation` - String - - + - [Public Preview] - - `display` - String - - + - [Public Preview] - - `name` - String - - + - [Public Preview] ::: @@ -376,7 +376,7 @@ Threshold to user for alert evaluation, can be a column or a value. **`Type: Map`** - +[Public Preview] @@ -388,15 +388,15 @@ Threshold to user for alert evaluation, can be a column or a value. - - `bool_value` - Boolean - - + - [Public Preview] - - `double_value` - Any - - + - [Public Preview] - - `string_value` - String - - + - [Public Preview] ::: @@ -459,7 +459,7 @@ Threshold to user for alert evaluation, can be a column or a value. **`Type: Map`** - +[Public Preview] @@ -471,11 +471,11 @@ Threshold to user for alert evaluation, can be a column or a value. - - `service_principal_name` - String - - Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role. + - [Public Preview] Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role. - - `user_name` - String - - The email of an active workspace user. Can only set this field to their own email. + - [Public Preview] The email of an active workspace user. Can only set this field to their own email. ::: @@ -484,7 +484,7 @@ Threshold to user for alert evaluation, can be a column or a value. **`Type: Map`** - +[Public Preview] @@ -496,15 +496,15 @@ Threshold to user for alert evaluation, can be a column or a value. - - `pause_status` - String - - Indicate whether this schedule is paused or not. + - [Public Preview] Indicate whether this schedule is paused or not. - - `quartz_cron_schedule` - String - - 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 + - [Public Preview] 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 - - `timezone_id` - String - - 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. + - [Public Preview] 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. ::: @@ -530,7 +530,7 @@ apps: - - `budget_policy_id` - String - - + - [Public Preview] - - `compute_max_instances` - Integer @@ -574,15 +574,15 @@ apps: - - `telemetry_export_destinations` - Sequence - - See [\_](#appsnametelemetry_export_destinations). + - [Public Preview]. See [\_](#appsnametelemetry_export_destinations). - - `usage_policy_id` - String - - + - [Public Preview] - - `user_api_scopes` - Sequence - - + - [Public Preview] ::: @@ -1064,7 +1064,7 @@ Resources for the app. **`Type: Sequence`** - +[Public Preview] @@ -2372,15 +2372,15 @@ database_catalogs: - - `create_database_if_not_exists` - Boolean - - + - [Public Preview] - - `database_instance_name` - String - - The name of the DatabaseInstance housing the database. + - [Public Preview] The name of the DatabaseInstance housing the database. - - `database_name` - String - - The name of the database (in a instance) associated with the catalog. + - [Public Preview] The name of the database (in a instance) associated with the catalog. - - `lifecycle` - Map @@ -2388,7 +2388,7 @@ database_catalogs: - - `name` - String - - The name of the catalog in UC. + - [Public Preview] The name of the catalog in UC. ::: @@ -2435,19 +2435,19 @@ database_instances: - - `capacity` - String - - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8". + - [Public Preview] The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8". - - `custom_tags` - Sequence - - Custom tags associated with the instance. This field is only included on create and update responses. See [\_](#database_instancesnamecustom_tags). + - [Public Beta] Custom tags associated with the instance. This field is only included on create and update responses. See [\_](#database_instancesnamecustom_tags). - - `enable_pg_native_login` - Boolean - - Whether to enable PG native password login on the instance. Defaults to false. + - [Public Preview] Whether to enable PG native password login on the instance. Defaults to false. - - `enable_readable_secondaries` - Boolean - - Whether to enable secondaries to serve read-only traffic. Defaults to false. + - [Public Preview] Whether to enable secondaries to serve read-only traffic. Defaults to false. - - `lifecycle` - Map @@ -2455,15 +2455,15 @@ database_instances: - - `name` - String - - The name of the instance. This is the unique identifier for the instance. + - [Public Preview] The name of the instance. This is the unique identifier for the instance. - - `node_count` - Integer - - 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. + - [Public Preview] 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. - - `parent_instance_ref` - Map - - 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. See [\_](#database_instancesnameparent_instance_ref). + - [Public Preview] 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. See [\_](#database_instancesnameparent_instance_ref). - - `permissions` - Sequence @@ -2471,15 +2471,15 @@ database_instances: - - `retention_window_in_days` - Integer - - 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. + - [Public Preview] 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. - - `stopped` - Boolean - - Whether to stop the instance. An input only param, see effective_stopped for the output. + - [Public Preview] Whether to stop the instance. An input only param, see effective_stopped for the output. - - `usage_policy_id` - String - - The desired usage policy to associate with the instance. + - [Public Beta] The desired usage policy to associate with the instance. ::: @@ -2488,7 +2488,7 @@ database_instances: **`Type: Sequence`** -Custom tags associated with the instance. This field is only included on create and update responses. +[Public Beta] Custom tags associated with the instance. This field is only included on create and update responses. @@ -2500,11 +2500,11 @@ Custom tags associated with the instance. This field is only included on create - - `key` - String - - The key of the custom tag. + - [Public Preview] The key of the custom tag. - - `value` - String - - The value of the custom tag. + - [Public Preview] The value of the custom tag. ::: @@ -2534,7 +2534,7 @@ Lifecycle is a struct that contains the lifecycle settings for a resource. It co **`Type: Map`** -The ref of the parent instance. This is only available if the instance is +[Public Preview] 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. @@ -2549,15 +2549,15 @@ Output: Only populated if provided as input to create a child instance. - - `branch_time` - String - - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child 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. + - [Public Preview] Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child 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. - - `lsn` - String - - 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. + - [Public Preview] 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. - - `name` - String - - Name of the ref database instance. + - [Public Preview] Name of the ref database instance. ::: @@ -3107,7 +3107,7 @@ jobs: - - `budget_policy_id` - String - - 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. + - [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. - - `continuous` - Map @@ -3319,7 +3319,7 @@ An optional set of email addresses that is notified when runs of this job begin - - `on_streaming_backlog_exceeded` - Sequence - - 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. + - [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. - - `on_success` - Sequence @@ -3388,7 +3388,7 @@ In this minimal environment spec, only pip and java dependencies are supported. - - `java_dependencies` - Sequence - - + - [Public Preview] ::: @@ -4567,7 +4567,7 @@ Read endpoints return only 100 tasks. If more than 100 tasks are available, you - - `alert_task` - Map - - The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. See [\_](#jobsnametasksalert_task). + - [Public Beta] The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. See [\_](#jobsnametasksalert_task). - - `clean_rooms_notebook_task` - Map @@ -4575,7 +4575,7 @@ Read endpoints return only 100 tasks. If more than 100 tasks are available, you - - `compute` - Map - - Task level compute configuration. See [\_](#jobsnametaskscompute). + - [Public Beta] Task level compute configuration. See [\_](#jobsnametaskscompute). - - `condition_task` - Map @@ -4659,7 +4659,7 @@ Read endpoints return only 100 tasks. If more than 100 tasks are available, you - - `power_bi_task` - Map - - The task triggers a Power BI semantic model update when the `power_bi_task` field is present. See [\_](#jobsnametaskspower_bi_task). + - [Public Preview] The task triggers a Power BI semantic model update when the `power_bi_task` field is present. See [\_](#jobsnametaskspower_bi_task). - - `python_wheel_task` - Map @@ -4712,7 +4712,7 @@ Read endpoints return only 100 tasks. If more than 100 tasks are available, you **`Type: Map`** -The task evaluates a Databricks alert and sends notifications to subscribers +[Public Beta] The task evaluates a Databricks alert and sends notifications to subscribers when the `alert_task` field is present. @@ -4725,19 +4725,19 @@ when the `alert_task` field is present. - - `alert_id` - String - - The alert_id is the canonical identifier of the alert. + - [Public Beta] The alert_id is the canonical identifier of the alert. - - `subscribers` - Sequence - - The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. See [\_](#jobsnametasksalert_tasksubscribers). + - [Public Beta] The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. See [\_](#jobsnametasksalert_tasksubscribers). - - `warehouse_id` - String - - The warehouse_id identifies the warehouse settings used by the alert task. + - [Public Beta] The warehouse_id identifies the warehouse settings used by the alert task. - - `workspace_path` - String - - 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. + - [Public Beta] 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. ::: @@ -4746,7 +4746,7 @@ when the `alert_task` field is present. **`Type: Sequence`** -The subscribers receive alert evaluation result notifications after the alert task is completed. +[Public Beta] The subscribers receive alert evaluation result notifications after the alert task is completed. The number of subscriptions is limited to 100. @@ -4759,11 +4759,11 @@ The number of subscriptions is limited to 100. - - `destination_id` - String - - + - [Public Beta] - - `user_name` - String - - A valid workspace email address. + - [Public Beta] A valid workspace email address. ::: @@ -4806,7 +4806,7 @@ when the `clean_rooms_notebook_task` field is present. **`Type: Map`** -Task level compute configuration. +[Public Beta] Task level compute configuration. @@ -4818,7 +4818,7 @@ Task level compute configuration. - - `hardware_accelerator` - String - - Hardware accelerator configuration for Serverless GPU workloads. + - [Public Beta] Hardware accelerator configuration for Serverless GPU workloads. ::: @@ -5039,7 +5039,7 @@ An optional set of email addresses that is notified when runs of this task begin - - `on_streaming_backlog_exceeded` - Sequence - - 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. + - [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. - - `on_success` - Sequence @@ -6174,7 +6174,7 @@ The task triggers a pipeline update when the `pipeline_task` field is present. O **`Type: Map`** -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. @@ -6186,23 +6186,23 @@ The task triggers a Power BI semantic model update when the `power_bi_task` fiel - - `connection_resource_name` - String - - 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` - Map - - The semantic model to update. See [\_](#jobsnametaskspower_bi_taskpower_bi_model). + - [Public Preview] The semantic model to update. See [\_](#jobsnametaskspower_bi_taskpower_bi_model). - - `refresh_after_update` - Boolean - - Whether the model should be refreshed after the update + - [Public Preview] Whether the model should be refreshed after the update - - `tables` - Sequence - - The tables to be exported to Power BI. See [\_](#jobsnametaskspower_bi_tasktables). + - [Public Preview] The tables to be exported to Power BI. See [\_](#jobsnametaskspower_bi_tasktables). - - `warehouse_id` - String - - 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 ::: @@ -6211,7 +6211,7 @@ The task triggers a Power BI semantic model update when the `power_bi_task` fiel **`Type: Map`** -The semantic model to update +[Public Preview] The semantic model to update @@ -6223,23 +6223,23 @@ The semantic model to update - - `authentication_method` - String - - How the published Power BI model authenticates to Databricks + - [Public Preview] How the published Power BI model authenticates to Databricks - - `model_name` - String - - The name of the Power BI model + - [Public Preview] The name of the Power BI model - - `overwrite_existing` - Boolean - - Whether to overwrite existing Power BI models + - [Public Preview] Whether to overwrite existing Power BI models - - `storage_mode` - String - - The default storage mode of the Power BI model + - [Public Preview] The default storage mode of the Power BI model - - `workspace_name` - String - - The name of the Power BI workspace of the model + - [Public Preview] The name of the Power BI workspace of the model ::: @@ -6248,7 +6248,7 @@ The semantic model to update **`Type: Sequence`** -The tables to be exported to Power BI +[Public Preview] The tables to be exported to Power BI @@ -6260,19 +6260,19 @@ The tables to be exported to Power BI - - `catalog` - String - - The catalog name in Databricks + - [Public Preview] The catalog name in Databricks - - `name` - String - - The table name in Databricks + - [Public Preview] The table name in Databricks - - `schema` - String - - The schema name in Databricks + - [Public Preview] The schema name in Databricks - - `storage_mode` - String - - The Power BI storage mode of the table + - [Public Preview] The Power BI storage mode of the table ::: @@ -6665,7 +6665,7 @@ A collection of system notification IDs to notify when runs of this task begin o - - `on_streaming_backlog_exceeded` - Sequence - - 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. See [\_](#jobsnametaskswebhook_notificationson_streaming_backlog_exceeded). + - [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. See [\_](#jobsnametaskswebhook_notificationson_streaming_backlog_exceeded). - - `on_success` - Sequence @@ -6741,7 +6741,7 @@ An optional list of system notification IDs to call when the run starts. A maxim **`Type: Sequence`** -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. @@ -6930,7 +6930,7 @@ A collection of system notification IDs to notify when runs of this job begin or - - `on_streaming_backlog_exceeded` - Sequence - - 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. See [\_](#jobsnamewebhook_notificationson_streaming_backlog_exceeded). + - [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. See [\_](#jobsnamewebhook_notificationson_streaming_backlog_exceeded). - - `on_success` - Sequence @@ -7006,7 +7006,7 @@ An optional list of system notification IDs to call when the run starts. A maxim **`Type: Sequence`** -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. @@ -7157,7 +7157,7 @@ The AI Gateway configuration for the serving endpoint. NOTE: External model, pro - - `guardrails` - Map - - Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses. See [\_](#model_serving_endpointsnameai_gatewayguardrails). + - [Public Preview] Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses. See [\_](#model_serving_endpointsnameai_gatewayguardrails). - - `inference_table_config` - Map @@ -7200,7 +7200,7 @@ entity fails with certain error codes, to increase availability. **`Type: Map`** -Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses. +[Public Preview] Configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses. @@ -7212,11 +7212,11 @@ Configuration for AI Guardrails to prevent unwanted data and unsafe data in requ - - `input` - Map - - Configuration for input guardrail filters. See [\_](#model_serving_endpointsnameai_gatewayguardrailsinput). + - [Public Preview] Configuration for input guardrail filters. See [\_](#model_serving_endpointsnameai_gatewayguardrailsinput). - - `output` - Map - - Configuration for output guardrail filters. See [\_](#model_serving_endpointsnameai_gatewayguardrailsoutput). + - [Public Preview] Configuration for output guardrail filters. See [\_](#model_serving_endpointsnameai_gatewayguardrailsoutput). ::: @@ -7225,7 +7225,7 @@ Configuration for AI Guardrails to prevent unwanted data and unsafe data in requ **`Type: Map`** -Configuration for input guardrail filters. +[Public Preview] Configuration for input guardrail filters. @@ -7241,11 +7241,11 @@ Configuration for input guardrail filters. - - `pii` - Map - - Configuration for guardrail PII filter. See [\_](#model_serving_endpointsnameai_gatewayguardrailsinputpii). + - [Public Preview] Configuration for guardrail PII filter. See [\_](#model_serving_endpointsnameai_gatewayguardrailsinputpii). - - `safety` - Boolean - - Indicates whether the safety filter is enabled. + - [Public Preview] Indicates whether the safety filter is enabled. - - `valid_topics` - Sequence @@ -7258,7 +7258,7 @@ Configuration for input guardrail filters. **`Type: Map`** -Configuration for guardrail PII filter. +[Public Preview] Configuration for guardrail PII filter. @@ -7270,7 +7270,7 @@ Configuration for guardrail PII filter. - - `behavior` - String - - Configuration for input guardrail filters. + - [Public Preview] Configuration for input guardrail filters. ::: @@ -7279,7 +7279,7 @@ Configuration for guardrail PII filter. **`Type: Map`** -Configuration for output guardrail filters. +[Public Preview] Configuration for output guardrail filters. @@ -7295,11 +7295,11 @@ Configuration for output guardrail filters. - - `pii` - Map - - Configuration for guardrail PII filter. See [\_](#model_serving_endpointsnameai_gatewayguardrailsoutputpii). + - [Public Preview] Configuration for guardrail PII filter. See [\_](#model_serving_endpointsnameai_gatewayguardrailsoutputpii). - - `safety` - Boolean - - Indicates whether the safety filter is enabled. + - [Public Preview] Indicates whether the safety filter is enabled. - - `valid_topics` - Sequence @@ -7312,7 +7312,7 @@ Configuration for output guardrail filters. **`Type: Map`** -Configuration for guardrail PII filter. +[Public Preview] Configuration for guardrail PII filter. @@ -7324,7 +7324,7 @@ Configuration for guardrail PII filter. - - `behavior` - String - - Configuration for input guardrail filters. + - [Public Preview] Configuration for input guardrail filters. ::: @@ -7471,7 +7471,7 @@ The list of served entities under the serving endpoint config. - - `burst_scaling_enabled` - Boolean - - 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. + - [Public Preview] 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. - - `entity_name` - String @@ -7491,7 +7491,7 @@ The list of served entities under the serving endpoint config. - - `instance_profile_arn` - String - - ARN of the instance profile that the served entity uses to access AWS resources. + - [Public Preview] ARN of the instance profile that the served entity uses to access AWS resources. - - `max_provisioned_concurrency` - Integer @@ -7515,7 +7515,7 @@ The list of served entities under the serving endpoint config. - - `provisioned_model_units` - Integer - - The number of model units provisioned. + - [Public Preview] The number of model units provisioned. - - `scale_to_zero_enabled` - Boolean @@ -7970,7 +7970,7 @@ PaLM Config. Only required if the provider is 'palm'. - - `burst_scaling_enabled` - Boolean - - 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. + - [Public Preview] 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. - - `environment_vars` - Map @@ -7978,7 +7978,7 @@ PaLM Config. Only required if the provider is 'palm'. - - `instance_profile_arn` - String - - ARN of the instance profile that the served entity uses to access AWS resources. + - [Public Preview] ARN of the instance profile that the served entity uses to access AWS resources. - - `max_provisioned_concurrency` - Integer @@ -8010,7 +8010,7 @@ PaLM Config. Only required if the provider is 'palm'. - - `provisioned_model_units` - Integer - - The number of model units provisioned. + - [Public Preview] The number of model units provisioned. - - `scale_to_zero_enabled` - Boolean @@ -8327,7 +8327,7 @@ pipelines: - - `budget_policy_id` - String - - Budget policy of this pipeline. + - [Public Preview] Budget policy of this pipeline. - - `catalog` - String @@ -8367,7 +8367,7 @@ pipelines: - - `environment` - Map - - Environment specification for this pipeline used to install dependencies. See [\_](#pipelinesnameenvironment). + - [Public Preview] Environment specification for this pipeline used to install dependencies. See [\_](#pipelinesnameenvironment). - - `event_log` - Map @@ -8383,7 +8383,7 @@ pipelines: - - `ingestion_definition` - Map - - The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. See [\_](#pipelinesnameingestion_definition). + - [Public Preview] The configuration for a managed ingestion pipeline. These settings cannot be used with the 'libraries', 'schema', 'target', or 'catalog' settings. See [\_](#pipelinesnameingestion_definition). - - `libraries` - Sequence @@ -8415,7 +8415,7 @@ pipelines: - - `root_path` - String - - 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. + - [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. - - `run_as` - Map @@ -9120,7 +9120,7 @@ Deployment type of this pipeline. **`Type: Map`** -Environment specification for this pipeline used to install dependencies. +[Public Preview] Environment specification for this pipeline used to install dependencies. @@ -9132,7 +9132,7 @@ Environment specification for this pipeline used to install dependencies. - - `dependencies` - Sequence - - 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), + - [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), ::: @@ -9195,7 +9195,7 @@ Filters on which Pipeline packages to include in the deployed graph. **`Type: Map`** -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. @@ -9207,31 +9207,31 @@ The configuration for a managed ingestion pipeline. These settings cannot be use - - `connection_name` - String - - 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 connector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion pipeline. Under certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed Ingestion Pipeline with Gateway pipeline. + - [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 connector_type defaults to QUERY_BASED. If connector_type is passed as CDC we use Combined Cdc Managed Ingestion pipeline. Under certain conditions, this can be replaced with ingestion_gateway_id to change the connector to Cdc Managed Ingestion Pipeline with Gateway pipeline. - - `full_refresh_window` - Map - - (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. See [\_](#pipelinesnameingestion_definitionfull_refresh_window). + - [Public Preview] (Optional) A window that specifies a set of time ranges for snapshot queries in CDC. See [\_](#pipelinesnameingestion_definitionfull_refresh_window). - - `ingest_from_uc_foreign_catalog` - Boolean - - 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. + - [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. - - `ingestion_gateway_id` - String - - 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. + - [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. - - `objects` - Sequence - - Required. Settings specifying tables to replicate and the destination for the replicated tables. See [\_](#pipelinesnameingestion_definitionobjects). + - [Public Preview] Required. Settings specifying tables to replicate and the destination for the replicated tables. See [\_](#pipelinesnameingestion_definitionobjects). - - `source_configurations` - Sequence - - Top-level source configurations. See [\_](#pipelinesnameingestion_definitionsource_configurations). + - [Public Preview] Top-level source configurations. See [\_](#pipelinesnameingestion_definitionsource_configurations). - - `table_configuration` - Map - - Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. See [\_](#pipelinesnameingestion_definitiontable_configuration). + - [Public Preview] Configuration settings to control the ingestion of tables. These settings are applied to all tables in the pipeline. See [\_](#pipelinesnameingestion_definitiontable_configuration). ::: @@ -9240,7 +9240,7 @@ The configuration for a managed ingestion pipeline. These settings cannot be use **`Type: Map`** -(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. @@ -9252,15 +9252,15 @@ The configuration for a managed ingestion pipeline. These settings cannot be use - - `days_of_week` - Sequence - - Days of week in which the window is allowed to happen If not specified all days of the week will be used. + - [Public Preview] Days of week in which the window is allowed to happen If not specified all days of the week will be used. - - `start_hour` - Integer - - 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. - - `time_zone_id` - String - - 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. + - [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. ::: @@ -9269,7 +9269,7 @@ The configuration for a managed ingestion pipeline. These settings cannot be use **`Type: Sequence`** -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. @@ -9277,7 +9277,7 @@ If not specified all days of the week will be used. **`Type: Sequence`** -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. @@ -9289,15 +9289,15 @@ Required. Settings specifying tables to replicate and the destination for the re - - `report` - Map - - Select a specific source report. See [\_](#pipelinesnameingestion_definitionobjectsreport). + - [Public Preview] Select a specific source report. See [\_](#pipelinesnameingestion_definitionobjectsreport). - - `schema` - Map - - Select all tables from a specific source schema. See [\_](#pipelinesnameingestion_definitionobjectsschema). + - [Public Preview] Select all tables from a specific source schema. See [\_](#pipelinesnameingestion_definitionobjectsschema). - - `table` - Map - - Select a specific source table. See [\_](#pipelinesnameingestion_definitionobjectstable). + - [Public Preview] Select a specific source table. See [\_](#pipelinesnameingestion_definitionobjectstable). ::: @@ -9306,7 +9306,7 @@ Required. Settings specifying tables to replicate and the destination for the re **`Type: Map`** -Select a specific source report. +[Public Preview] Select a specific source report. @@ -9318,23 +9318,23 @@ Select a specific source report. - - `destination_catalog` - String - - Required. Destination catalog to store table. + - [Public Preview] Required. Destination catalog to store table. - - `destination_schema` - String - - Required. Destination schema to store table. + - [Public Preview] Required. Destination schema to store table. - - `destination_table` - String - - 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. - - `source_url` - String - - Required. Report URL in the source system. + - [Public Preview] Required. Report URL in the source system. - - `table_configuration` - Map - - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. See [\_](#pipelinesnameingestion_definitionobjectsreporttable_configuration). + - [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object. See [\_](#pipelinesnameingestion_definitionobjectsreporttable_configuration). ::: @@ -9343,7 +9343,7 @@ Select a specific source report. **`Type: Map`** -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. @@ -9355,35 +9355,35 @@ Configuration settings to control the ingestion of tables. These settings overri - - `auto_full_refresh_policy` - Map - - (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, { "auto_full_refresh_policy": { "enabled": true, "min_interval_hours": 23, } } If unspecified, auto full refresh is disabled. See [\_](#pipelinesnameingestion_definitionobjectsreporttable_configurationauto_full_refresh_policy). + - [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, { "auto_full_refresh_policy": { "enabled": true, "min_interval_hours": 23, } } If unspecified, auto full refresh is disabled. See [\_](#pipelinesnameingestion_definitionobjectsreporttable_configurationauto_full_refresh_policy). - - `exclude_columns` - Sequence - - 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`. + - [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`. - - `include_columns` - Sequence - - 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. This field in mutually exclusive with `exclude_columns`. + - [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. This field in mutually exclusive with `exclude_columns`. - - `primary_keys` - Sequence - - 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` - Map - - Configurations that are only applicable for query-based ingestion connectors. See [\_](#pipelinesnameingestion_definitionobjectsreporttable_configurationquery_based_connector_config). + - [Public Preview] Configurations that are only applicable for query-based ingestion connectors. See [\_](#pipelinesnameingestion_definitionobjectsreporttable_configurationquery_based_connector_config). - - `row_filter` - String - - (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. + - [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. - - `scd_type` - String - - The SCD type to use to ingest the table. + - [Public Preview] The SCD type to use to ingest the table. - - `sequence_by` - Sequence - - 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. ::: @@ -9392,7 +9392,7 @@ Configuration settings to control the ingestion of tables. These settings overri **`Type: Map`** -(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, @@ -9414,11 +9414,11 @@ If unspecified, auto full refresh is disabled. - - `enabled` - Boolean - - (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` - Integer - - (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. + - [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. ::: @@ -9427,7 +9427,7 @@ If unspecified, auto full refresh is disabled. **`Type: Map`** -Configurations that are only applicable for query-based ingestion connectors. +[Public Preview] Configurations that are only applicable for query-based ingestion connectors. @@ -9439,15 +9439,15 @@ Configurations that are only applicable for query-based ingestion connectors. - - `cursor_columns` - Sequence - - 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 columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. + - [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 columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. - - `deletion_condition` - String - - 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`, 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. + - [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`, 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. - - `hard_deletion_sync_min_interval_in_seconds` - Integer - - 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 this value, hard deletion synchronization will align with the actual ingestion 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. + - [Public 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 this value, hard deletion synchronization will align with the actual ingestion 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. ::: @@ -9456,7 +9456,7 @@ Configurations that are only applicable for query-based ingestion connectors. **`Type: Map`** -Select all tables from a specific source schema. +[Public Preview] Select all tables from a specific source schema. @@ -9468,27 +9468,27 @@ Select all tables from a specific source schema. - - `connector_options` - Map - - (Optional) Source Specific Connector Options. See [\_](#pipelinesnameingestion_definitionobjectsschemaconnector_options). + - [Public Preview] (Optional) Source Specific Connector Options. See [\_](#pipelinesnameingestion_definitionobjectsschemaconnector_options). - - `destination_catalog` - String - - Required. Destination catalog to store tables. + - [Public Preview] Required. Destination catalog to store tables. - - `destination_schema` - String - - 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_catalog` - String - - 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. - - `source_schema` - String - - Required. Schema name in the source database. + - [Public Preview] Required. Schema name in the source database. - - `table_configuration` - Map - - 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. See [\_](#pipelinesnameingestion_definitionobjectsschematable_configuration). + - [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. See [\_](#pipelinesnameingestion_definitionobjectsschematable_configuration). ::: @@ -9497,7 +9497,7 @@ Select all tables from a specific source schema. **`Type: Map`** -(Optional) Source Specific Connector Options +[Public Preview] (Optional) Source Specific Connector Options @@ -9509,15 +9509,15 @@ Select all tables from a specific source schema. - - `confluence_options` - Map - - Confluence specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectsschemaconnector_optionsconfluence_options). + - [Public Preview] Confluence specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectsschemaconnector_optionsconfluence_options). - - `jira_options` - Map - - Jira specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectsschemaconnector_optionsjira_options). + - [Public Beta] Jira specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectsschemaconnector_optionsjira_options). - - `meta_ads_options` - Map - - Meta Marketing (Meta Ads) specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectsschemaconnector_optionsmeta_ads_options). + - [Public Beta] Meta Marketing (Meta Ads) specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectsschemaconnector_optionsmeta_ads_options). ::: @@ -9526,7 +9526,7 @@ Select all tables from a specific source schema. **`Type: Map`** -Confluence specific options for ingestion +[Public Preview] Confluence specific options for ingestion @@ -9538,7 +9538,7 @@ Confluence specific options for ingestion - - `include_confluence_spaces` - Sequence - - (Optional) Spaces to filter Confluence data on + - [Public Preview] (Optional) Spaces to filter Confluence data on ::: @@ -9547,7 +9547,7 @@ Confluence specific options for ingestion **`Type: Map`** -Jira specific options for ingestion +[Public Beta] Jira specific options for ingestion @@ -9559,7 +9559,7 @@ Jira specific options for ingestion - - `include_jira_spaces` - Sequence - - (Optional) Projects to filter Jira data on + - [Public Beta] (Optional) Projects to filter Jira data on ::: @@ -9568,7 +9568,7 @@ Jira specific options for ingestion **`Type: Map`** -Meta Marketing (Meta Ads) specific options for ingestion +[Public Beta] Meta Marketing (Meta Ads) specific options for ingestion @@ -9580,35 +9580,35 @@ Meta Marketing (Meta Ads) specific options for ingestion - - `action_attribution_windows` - Sequence - - (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") + - [Public Beta] (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") - - `action_breakdowns` - Sequence - - (Optional) Action breakdowns to configure for data aggregation + - [Public Beta] (Optional) Action breakdowns to configure for data aggregation - - `action_report_time` - String - - (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) + - [Public Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) - - `breakdowns` - Sequence - - (Optional) Breakdowns to configure for data aggregation + - [Public Beta] (Optional) Breakdowns to configure for data aggregation - - `custom_insights_lookback_window` - Integer - - (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. + - [Public Beta] (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. - - `level` - String - - (Optional) Granularity of data to pull (account, ad, adset, campaign) + - [Public Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign) - - `start_date` - String - - (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested + - [Public Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested - - `time_increment` - String - - (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) + - [Public Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) ::: @@ -9617,7 +9617,7 @@ Meta Marketing (Meta Ads) specific options for ingestion **`Type: Map`** -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. @@ -9629,35 +9629,35 @@ Configuration settings to control the ingestion of tables. These settings are ap - - `auto_full_refresh_policy` - Map - - (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, { "auto_full_refresh_policy": { "enabled": true, "min_interval_hours": 23, } } If unspecified, auto full refresh is disabled. See [\_](#pipelinesnameingestion_definitionobjectsschematable_configurationauto_full_refresh_policy). + - [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, { "auto_full_refresh_policy": { "enabled": true, "min_interval_hours": 23, } } If unspecified, auto full refresh is disabled. See [\_](#pipelinesnameingestion_definitionobjectsschematable_configurationauto_full_refresh_policy). - - `exclude_columns` - Sequence - - 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`. + - [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`. - - `include_columns` - Sequence - - 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. This field in mutually exclusive with `exclude_columns`. + - [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. This field in mutually exclusive with `exclude_columns`. - - `primary_keys` - Sequence - - 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` - Map - - Configurations that are only applicable for query-based ingestion connectors. See [\_](#pipelinesnameingestion_definitionobjectsschematable_configurationquery_based_connector_config). + - [Public Preview] Configurations that are only applicable for query-based ingestion connectors. See [\_](#pipelinesnameingestion_definitionobjectsschematable_configurationquery_based_connector_config). - - `row_filter` - String - - (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. + - [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. - - `scd_type` - String - - The SCD type to use to ingest the table. + - [Public Preview] The SCD type to use to ingest the table. - - `sequence_by` - Sequence - - 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. ::: @@ -9666,7 +9666,7 @@ Configuration settings to control the ingestion of tables. These settings are ap **`Type: Map`** -(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, @@ -9688,11 +9688,11 @@ If unspecified, auto full refresh is disabled. - - `enabled` - Boolean - - (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` - Integer - - (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. + - [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. ::: @@ -9701,7 +9701,7 @@ If unspecified, auto full refresh is disabled. **`Type: Map`** -Configurations that are only applicable for query-based ingestion connectors. +[Public Preview] Configurations that are only applicable for query-based ingestion connectors. @@ -9713,15 +9713,15 @@ Configurations that are only applicable for query-based ingestion connectors. - - `cursor_columns` - Sequence - - 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 columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. + - [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 columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. - - `deletion_condition` - String - - 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`, 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. + - [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`, 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. - - `hard_deletion_sync_min_interval_in_seconds` - Integer - - 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 this value, hard deletion synchronization will align with the actual ingestion 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. + - [Public 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 this value, hard deletion synchronization will align with the actual ingestion 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. ::: @@ -9730,7 +9730,7 @@ Configurations that are only applicable for query-based ingestion connectors. **`Type: Map`** -Select a specific source table. +[Public Preview] Select a specific source table. @@ -9742,35 +9742,35 @@ Select a specific source table. - - `connector_options` - Map - - (Optional) Source Specific Connector Options. See [\_](#pipelinesnameingestion_definitionobjectstableconnector_options). + - [Public Preview] (Optional) Source Specific Connector Options. See [\_](#pipelinesnameingestion_definitionobjectstableconnector_options). - - `destination_catalog` - String - - Required. Destination catalog to store table. + - [Public Preview] Required. Destination catalog to store table. - - `destination_schema` - String - - Required. Destination schema to store table. + - [Public Preview] Required. Destination schema to store table. - - `destination_table` - String - - 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` - String - - 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` - String - - 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. - - `source_table` - String - - Required. Table name in the source database. + - [Public Preview] Required. Table name in the source database. - - `table_configuration` - Map - - Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. See [\_](#pipelinesnameingestion_definitionobjectstabletable_configuration). + - [Public Preview] Configuration settings to control the ingestion of tables. These settings override the table_configuration defined in the IngestionPipelineDefinition object and the SchemaSpec. See [\_](#pipelinesnameingestion_definitionobjectstabletable_configuration). ::: @@ -9779,7 +9779,7 @@ Select a specific source table. **`Type: Map`** -(Optional) Source Specific Connector Options +[Public Preview] (Optional) Source Specific Connector Options @@ -9791,15 +9791,15 @@ Select a specific source table. - - `confluence_options` - Map - - Confluence specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectstableconnector_optionsconfluence_options). + - [Public Preview] Confluence specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectstableconnector_optionsconfluence_options). - - `jira_options` - Map - - Jira specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectstableconnector_optionsjira_options). + - [Public Beta] Jira specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectstableconnector_optionsjira_options). - - `meta_ads_options` - Map - - Meta Marketing (Meta Ads) specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectstableconnector_optionsmeta_ads_options). + - [Public Beta] Meta Marketing (Meta Ads) specific options for ingestion. See [\_](#pipelinesnameingestion_definitionobjectstableconnector_optionsmeta_ads_options). ::: @@ -9808,7 +9808,7 @@ Select a specific source table. **`Type: Map`** -Confluence specific options for ingestion +[Public Preview] Confluence specific options for ingestion @@ -9820,7 +9820,7 @@ Confluence specific options for ingestion - - `include_confluence_spaces` - Sequence - - (Optional) Spaces to filter Confluence data on + - [Public Preview] (Optional) Spaces to filter Confluence data on ::: @@ -9829,7 +9829,7 @@ Confluence specific options for ingestion **`Type: Map`** -Jira specific options for ingestion +[Public Beta] Jira specific options for ingestion @@ -9841,7 +9841,7 @@ Jira specific options for ingestion - - `include_jira_spaces` - Sequence - - (Optional) Projects to filter Jira data on + - [Public Beta] (Optional) Projects to filter Jira data on ::: @@ -9850,7 +9850,7 @@ Jira specific options for ingestion **`Type: Map`** -Meta Marketing (Meta Ads) specific options for ingestion +[Public Beta] Meta Marketing (Meta Ads) specific options for ingestion @@ -9862,35 +9862,35 @@ Meta Marketing (Meta Ads) specific options for ingestion - - `action_attribution_windows` - Sequence - - (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") + - [Public Beta] (Optional) Action attribution windows for insights reporting (e.g. "28d_click", "1d_view") - - `action_breakdowns` - Sequence - - (Optional) Action breakdowns to configure for data aggregation + - [Public Beta] (Optional) Action breakdowns to configure for data aggregation - - `action_report_time` - String - - (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) + - [Public Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) - - `breakdowns` - Sequence - - (Optional) Breakdowns to configure for data aggregation + - [Public Beta] (Optional) Breakdowns to configure for data aggregation - - `custom_insights_lookback_window` - Integer - - (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. + - [Public Beta] (Optional) Window in days to revisit data during sync to capture updated conversion data from the API. - - `level` - String - - (Optional) Granularity of data to pull (account, ad, adset, campaign) + - [Public Beta] (Optional) Granularity of data to pull (account, ad, adset, campaign) - - `start_date` - String - - (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested + - [Public Beta] (Optional) Start date in yyyy-MM-dd format (e.g. 2025-01-15). Data added after this date will be ingested - - `time_increment` - String - - (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) + - [Public Beta] (Optional) Value in string by which to aggregate statistics (can take all_days, monthly or number of days) ::: @@ -9899,7 +9899,7 @@ Meta Marketing (Meta Ads) specific options for ingestion **`Type: Map`** -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. @@ -9911,35 +9911,35 @@ Configuration settings to control the ingestion of tables. These settings overri - - `auto_full_refresh_policy` - Map - - (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, { "auto_full_refresh_policy": { "enabled": true, "min_interval_hours": 23, } } If unspecified, auto full refresh is disabled. See [\_](#pipelinesnameingestion_definitionobjectstabletable_configurationauto_full_refresh_policy). + - [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, { "auto_full_refresh_policy": { "enabled": true, "min_interval_hours": 23, } } If unspecified, auto full refresh is disabled. See [\_](#pipelinesnameingestion_definitionobjectstabletable_configurationauto_full_refresh_policy). - - `exclude_columns` - Sequence - - 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`. + - [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`. - - `include_columns` - Sequence - - 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. This field in mutually exclusive with `exclude_columns`. + - [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. This field in mutually exclusive with `exclude_columns`. - - `primary_keys` - Sequence - - 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` - Map - - Configurations that are only applicable for query-based ingestion connectors. See [\_](#pipelinesnameingestion_definitionobjectstabletable_configurationquery_based_connector_config). + - [Public Preview] Configurations that are only applicable for query-based ingestion connectors. See [\_](#pipelinesnameingestion_definitionobjectstabletable_configurationquery_based_connector_config). - - `row_filter` - String - - (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. + - [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. - - `scd_type` - String - - The SCD type to use to ingest the table. + - [Public Preview] The SCD type to use to ingest the table. - - `sequence_by` - Sequence - - 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. ::: @@ -9948,7 +9948,7 @@ Configuration settings to control the ingestion of tables. These settings overri **`Type: Map`** -(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, @@ -9970,11 +9970,11 @@ If unspecified, auto full refresh is disabled. - - `enabled` - Boolean - - (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` - Integer - - (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. + - [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. ::: @@ -9983,7 +9983,7 @@ If unspecified, auto full refresh is disabled. **`Type: Map`** -Configurations that are only applicable for query-based ingestion connectors. +[Public Preview] Configurations that are only applicable for query-based ingestion connectors. @@ -9995,15 +9995,15 @@ Configurations that are only applicable for query-based ingestion connectors. - - `cursor_columns` - Sequence - - 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 columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. + - [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 columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. - - `deletion_condition` - String - - 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`, 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. + - [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`, 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. - - `hard_deletion_sync_min_interval_in_seconds` - Integer - - 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 this value, hard deletion synchronization will align with the actual ingestion 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. + - [Public 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 this value, hard deletion synchronization will align with the actual ingestion 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. ::: @@ -10012,7 +10012,7 @@ Configurations that are only applicable for query-based ingestion connectors. **`Type: Sequence`** -Top-level source configurations +[Public Preview] Top-level source configurations @@ -10024,7 +10024,7 @@ Top-level source configurations - - `catalog` - Map - - Catalog-level source configuration parameters. See [\_](#pipelinesnameingestion_definitionsource_configurationscatalog). + - [Public Preview] Catalog-level source configuration parameters. See [\_](#pipelinesnameingestion_definitionsource_configurationscatalog). ::: @@ -10033,7 +10033,7 @@ Top-level source configurations **`Type: Map`** -Catalog-level source configuration parameters +[Public Preview] Catalog-level source configuration parameters @@ -10045,11 +10045,11 @@ Catalog-level source configuration parameters - - `postgres` - Map - - Postgres-specific catalog-level configuration parameters. See [\_](#pipelinesnameingestion_definitionsource_configurationscatalogpostgres). + - [Public Preview] Postgres-specific catalog-level configuration parameters. See [\_](#pipelinesnameingestion_definitionsource_configurationscatalogpostgres). - - `source_catalog` - String - - Source catalog name + - [Public Preview] Source catalog name ::: @@ -10058,7 +10058,7 @@ Catalog-level source configuration parameters **`Type: Map`** -Postgres-specific catalog-level configuration parameters +[Public Preview] Postgres-specific catalog-level configuration parameters @@ -10070,7 +10070,7 @@ Postgres-specific catalog-level configuration parameters - - `slot_config` - Map - - Optional. The Postgres slot configuration to use for logical replication. See [\_](#pipelinesnameingestion_definitionsource_configurationscatalogpostgresslot_config). + - [Public Preview] Optional. The Postgres slot configuration to use for logical replication. See [\_](#pipelinesnameingestion_definitionsource_configurationscatalogpostgresslot_config). ::: @@ -10079,7 +10079,7 @@ Postgres-specific catalog-level configuration parameters **`Type: Map`** -Optional. The Postgres slot configuration to use for logical replication +[Public Preview] Optional. The Postgres slot configuration to use for logical replication @@ -10091,11 +10091,11 @@ Optional. The Postgres slot configuration to use for logical replication - - `publication_name` - String - - 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` - String - - 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 ::: @@ -10104,7 +10104,7 @@ Optional. The Postgres slot configuration to use for logical replication **`Type: Map`** -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. @@ -10116,35 +10116,35 @@ Configuration settings to control the ingestion of tables. These settings are ap - - `auto_full_refresh_policy` - Map - - (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, { "auto_full_refresh_policy": { "enabled": true, "min_interval_hours": 23, } } If unspecified, auto full refresh is disabled. See [\_](#pipelinesnameingestion_definitiontable_configurationauto_full_refresh_policy). + - [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, { "auto_full_refresh_policy": { "enabled": true, "min_interval_hours": 23, } } If unspecified, auto full refresh is disabled. See [\_](#pipelinesnameingestion_definitiontable_configurationauto_full_refresh_policy). - - `exclude_columns` - Sequence - - 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`. + - [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`. - - `include_columns` - Sequence - - 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. This field in mutually exclusive with `exclude_columns`. + - [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. This field in mutually exclusive with `exclude_columns`. - - `primary_keys` - Sequence - - 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` - Map - - Configurations that are only applicable for query-based ingestion connectors. See [\_](#pipelinesnameingestion_definitiontable_configurationquery_based_connector_config). + - [Public Preview] Configurations that are only applicable for query-based ingestion connectors. See [\_](#pipelinesnameingestion_definitiontable_configurationquery_based_connector_config). - - `row_filter` - String - - (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. + - [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. - - `scd_type` - String - - The SCD type to use to ingest the table. + - [Public Preview] The SCD type to use to ingest the table. - - `sequence_by` - Sequence - - 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. ::: @@ -10153,7 +10153,7 @@ Configuration settings to control the ingestion of tables. These settings are ap **`Type: Map`** -(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, @@ -10175,11 +10175,11 @@ If unspecified, auto full refresh is disabled. - - `enabled` - Boolean - - (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` - Integer - - (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. + - [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. ::: @@ -10188,7 +10188,7 @@ If unspecified, auto full refresh is disabled. **`Type: Map`** -Configurations that are only applicable for query-based ingestion connectors. +[Public Preview] Configurations that are only applicable for query-based ingestion connectors. @@ -10200,15 +10200,15 @@ Configurations that are only applicable for query-based ingestion connectors. - - `cursor_columns` - Sequence - - 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 columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. + - [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 columns will implicitly define the `sequence_by` behavior. You can still explicitly set `sequence_by` to override this default. - - `deletion_condition` - String - - 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`, 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. + - [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`, 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. - - `hard_deletion_sync_min_interval_in_seconds` - Integer - - 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 this value, hard deletion synchronization will align with the actual ingestion 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. + - [Public 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 this value, hard deletion synchronization will align with the actual ingestion 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. ::: @@ -10233,7 +10233,7 @@ Libraries or code needed by this deployment. - - `glob` - Map - - 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`. See [\_](#pipelinesnamelibrariesglob). + - [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`. See [\_](#pipelinesnamelibrariesglob). - - `notebook` - Map @@ -10271,7 +10271,7 @@ The path to a file that defines a pipeline and is stored in the Databricks Repos **`Type: Map`** -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`. @@ -10285,7 +10285,7 @@ This field cannot be used together with `notebook` or `file`. - - `include` - String - - The source code to include for pipelines + - [Public Preview] The source code to include for pipelines ::: @@ -10653,15 +10653,15 @@ postgres_endpoints: - - `enable_readable_secondaries` - Boolean - - Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where size.max > 1. + - [Public Beta] Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where size.max > 1. - - `max` - Integer - - 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. + - [Public Beta] 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. - - `min` - Integer - - 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. + - [Public Beta] 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. ::: @@ -10703,7 +10703,7 @@ A collection of settings for a compute endpoint. - - `pg_settings` - Map - - A raw representation of Postgres settings. + - [Public Beta] A raw representation of Postgres settings. ::: @@ -10771,6 +10771,10 @@ postgres_projects: - String - +- - `purge_on_delete` + - Boolean + - + ::: @@ -10790,11 +10794,11 @@ postgres_projects: - - `key` - String - - The key of the custom tag. + - [Public Beta] The key of the custom tag. - - `value` - String - - The value of the custom tag. + - [Public Beta] The value of the custom tag. ::: @@ -10815,23 +10819,23 @@ A collection of settings for a compute endpoint. - - `autoscaling_limit_max_cu` - Any - - The maximum number of Compute Units. Minimum value is 0.5. + - [Public Beta] The maximum number of Compute Units. Minimum value is 0.5. - - `autoscaling_limit_min_cu` - Any - - The minimum number of Compute Units. Minimum value is 0.5. + - [Public Beta] The minimum number of Compute Units. Minimum value is 0.5. - - `no_suspension` - Boolean - - 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. + - [Public Beta] 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. - - `pg_settings` - Map - - A raw representation of Postgres settings. + - [Public Beta] A raw representation of Postgres settings. - - `suspend_timeout_duration` - String - - 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. + - [Public Beta] 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. ::: @@ -10993,15 +10997,15 @@ postgres_synced_tables: - - `budget_policy_id` - String - - Budget policy to set on the newly created pipeline. + - [Public Beta] Budget policy to set on the newly created pipeline. - - `storage_catalog` - String - - 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. + - [Public Beta] 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. - - `storage_schema` - String - - 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. + - [Public Beta] 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. ::: @@ -11909,6 +11913,10 @@ Lifecycle is a struct that contains the lifecycle settings for a resource. It co - Boolean - Lifecycle setting to prevent the resource from being destroyed. +- - `started` + - Boolean + - Lifecycle setting to deploy the resource in started mode. Only supported for apps, clusters, and sql_warehouses in direct deployment mode. + ::: @@ -12016,7 +12024,7 @@ synced_database_tables: - - `database_instance_name` - String - - + - [Public Preview] - - `lifecycle` - Map @@ -12024,15 +12032,15 @@ synced_database_tables: - - `logical_database_name` - String - - + - [Public Preview] - - `name` - String - - + - [Public Preview] - - `spec` - Map - - Specification of a synced database table. See [\_](#synced_database_tablesnamespec). + - [Public Preview]. See [\_](#synced_database_tablesnamespec). ::: @@ -12062,7 +12070,7 @@ synced_database_tables: **`Type: Map`** -Specification of a synced database table. +[Public Preview] @@ -12074,31 +12082,31 @@ Specification of a synced database table. - - `create_database_objects_if_missing` - Boolean - - If true, the synced table's logical database and schema resources in PG will be created if they do not already exist. + - [Public Preview] If true, the synced table's logical database and schema resources in PG will be created if they do not already exist. - - `existing_pipeline_id` - String - - At most one of existing_pipeline_id and new_pipeline_spec should be defined. 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. + - [Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined. 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. - - `new_pipeline_spec` - Map - - At most one of existing_pipeline_id and new_pipeline_spec should be defined. If new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used 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. See [\_](#synced_database_tablesnamespecnew_pipeline_spec). + - [Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined. If new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used 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. See [\_](#synced_database_tablesnamespecnew_pipeline_spec). - - `primary_key_columns` - Sequence - - Primary Key columns to be used for data insert/update in the destination. + - [Public Preview] Primary Key columns to be used for data insert/update in the destination. - - `scheduling_policy` - String - - Scheduling policy of the underlying pipeline. + - [Public Preview] Scheduling policy of the underlying pipeline. - - `source_table_full_name` - String - - Three-part (catalog, schema, table) name of the source Delta table. + - [Public Preview] Three-part (catalog, schema, table) name of the source Delta table. - - `timeseries_key` - String - - Time series key to deduplicate (tie-break) rows with the same primary key. + - [Public Preview] Time series key to deduplicate (tie-break) rows with the same primary key. ::: @@ -12107,7 +12115,7 @@ Specification of a synced database table. **`Type: Map`** -At most one of existing_pipeline_id and new_pipeline_spec should be defined. +[Public Preview] At most one of existing_pipeline_id and new_pipeline_spec should be defined. If new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used to store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta @@ -12124,15 +12132,15 @@ only requires read permissions. - - `budget_policy_id` - String - - Budget policy to set on the newly created pipeline. + - [Public Beta] Budget policy to set on the newly created pipeline. - - `storage_catalog` - String - - 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. + - [Public Preview] 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. - - `storage_schema` - String - - 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. + - [Public Preview] 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. ::: @@ -12158,7 +12166,7 @@ vector_search_endpoints: - - `budget_policy_id` - String - - + - [Public Preview] - - `endpoint_type` - String @@ -12178,7 +12186,7 @@ vector_search_endpoints: - - `target_qps` - Integer - - + - [Public Preview] ::: diff --git a/bundle/internal/schema/parser.go b/bundle/internal/schema/parser.go index 26c06bbc230..94a86dd9a11 100644 --- a/bundle/internal/schema/parser.go +++ b/bundle/internal/schema/parser.go @@ -249,8 +249,6 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid } basePath := getPath(typ) - pkg := map[string]annotation.Descriptor{} - annotations[basePath] = pkg preview := normalizePreview(ref.Preview) launchStage := normalizeLaunchStage(ref.LaunchStage) enumValues := filterDevelopmentEnumValues(ref.Enum, ref.EnumMetadata) @@ -263,6 +261,8 @@ func (p *openapiParser) extractAnnotations(typ reflect.Type, outputPath, overrid if launchStage == "DEVELOPMENT" { return s } + pkg := map[string]annotation.Descriptor{} + annotations[basePath] = pkg if ref.Description != "" || enumValues != nil || ref.Deprecated || ref.DeprecationMessage != "" || preview != "" || launchStage != "" || enumLaunchStages != nil || enumDescriptions != nil || outputOnly != nil { if ref.Deprecated && ref.DeprecationMessage == "" { ref.DeprecationMessage = "This field is deprecated" diff --git a/python/databricks/bundles/catalogs/_models/privilege.py b/python/databricks/bundles/catalogs/_models/privilege.py index 74f25b462c1..20f4e1f5573 100644 --- a/python/databricks/bundles/catalogs/_models/privilege.py +++ b/python/databricks/bundles/catalogs/_models/privilege.py @@ -53,20 +53,6 @@ class Privilege(Enum): MODIFY_CLEAN_ROOM = "MODIFY_CLEAN_ROOM" EXECUTE_CLEAN_ROOM_TASK = "EXECUTE_CLEAN_ROOM_TASK" EXTERNAL_USE_SCHEMA = "EXTERNAL_USE_SCHEMA" - VIEW_OBJECT = "VIEW_OBJECT" - MANAGE_GRANTS = "MANAGE_GRANTS" - INSERT = "INSERT" - UPDATE = "UPDATE" - DELETE = "DELETE" - VIEW_ADMIN_METADATA = "VIEW_ADMIN_METADATA" - VIEW_METADATA = "VIEW_METADATA" - USE_VOLUME = "USE_VOLUME" - READ_METADATA = "READ_METADATA" - MANAGE_ACCESS = "MANAGE_ACCESS" - MANAGE_ACCESS_CONTROL = "MANAGE_ACCESS_CONTROL" - CREATE_SERVICE = "CREATE_SERVICE" - CREATE_FEATURE = "CREATE_FEATURE" - READ_FEATURE = "READ_FEATURE" PrivilegeParam = ( @@ -121,20 +107,6 @@ class Privilege(Enum): "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", "EXTERNAL_USE_SCHEMA", - "VIEW_OBJECT", - "MANAGE_GRANTS", - "INSERT", - "UPDATE", - "DELETE", - "VIEW_ADMIN_METADATA", - "VIEW_METADATA", - "USE_VOLUME", - "READ_METADATA", - "MANAGE_ACCESS", - "MANAGE_ACCESS_CONTROL", - "CREATE_SERVICE", - "CREATE_FEATURE", - "READ_FEATURE", ] | Privilege ) diff --git a/python/databricks/bundles/jobs/_models/alert_task.py b/python/databricks/bundles/jobs/_models/alert_task.py index b044b797780..d654d833b10 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 Beta] 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 Beta] 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 Beta] 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 Beta] 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 Beta] 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 Beta] 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 Beta] 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 Beta] 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..b3266160a70 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 Beta] + """ user_name: VariableOrOptional[str] = None """ - A valid workspace email address. + [Public Beta] A valid workspace email address. """ @classmethod @@ -35,10 +38,13 @@ class AlertTaskSubscriberDict(TypedDict, total=False): """""" destination_id: VariableOrOptional[str] + """ + [Public Beta] + """ user_name: VariableOrOptional[str] """ - A valid workspace email address. + [Public Beta] 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..560f6ca6577 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. + [Public 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. + [Public 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 b1194a80cde..e60994a73b5 100644 --- a/python/databricks/bundles/jobs/_models/compute_config.py +++ b/python/databricks/bundles/jobs/_models/compute_config.py @@ -17,17 +17,17 @@ class ComputeConfig: num_gpus: VariableOr[int] """ - Number of GPUs. + [Private Preview] Number of GPUs. """ gpu_node_pool_id: VariableOrOptional[str] = None """ - IDof the GPU pool to use. + [Private Preview] IDof the GPU pool to use. """ gpu_type: VariableOrOptional[str] = None """ - GPU type. + [Private Preview] GPU type. """ @classmethod @@ -43,17 +43,17 @@ class ComputeConfigDict(TypedDict, total=False): num_gpus: VariableOr[int] """ - Number of GPUs. + [Private Preview] Number of GPUs. """ gpu_node_pool_id: VariableOrOptional[str] """ - IDof the GPU pool to use. + [Private Preview] IDof the GPU pool to use. """ gpu_type: VariableOrOptional[str] """ - 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 92cf53ac861..449e802303d 100644 --- a/python/databricks/bundles/jobs/_models/dbt_platform_task.py +++ b/python/databricks/bundles/jobs/_models/dbt_platform_task.py @@ -17,12 +17,12 @@ class DbtPlatformTask: connection_resource_name: VariableOrOptional[str] = None """ - 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 """ - 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 @@ -38,12 +38,12 @@ class DbtPlatformTaskDict(TypedDict, total=False): connection_resource_name: VariableOrOptional[str] """ - 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] """ - 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 4d2c4b972c8..21779f35779 100644 --- a/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py +++ b/python/databricks/bundles/jobs/_models/gen_ai_compute_task.py @@ -22,25 +22,28 @@ class GenAiComputeTask: dl_runtime_image: VariableOr[str] """ - Runtime image + [Private Preview] Runtime image """ command: VariableOrOptional[str] = None """ - 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 + """ + [Private Preview] + """ mlflow_experiment_name: VariableOrOptional[str] = None """ - 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. """ source: VariableOrOptional[Source] = None """ - 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. @@ -48,18 +51,18 @@ class GenAiComputeTask: training_script_path: VariableOrOptional[str] = None """ - 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 """ - 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. """ yaml_parameters_file_path: VariableOrOptional[str] = None """ - 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 @@ -75,25 +78,28 @@ class GenAiComputeTaskDict(TypedDict, total=False): dl_runtime_image: VariableOr[str] """ - Runtime image + [Private Preview] Runtime image """ command: VariableOrOptional[str] """ - 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] + """ + [Private Preview] + """ mlflow_experiment_name: VariableOrOptional[str] """ - 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. """ source: VariableOrOptional[SourceParam] """ - 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. @@ -101,18 +107,18 @@ class GenAiComputeTaskDict(TypedDict, total=False): training_script_path: VariableOrOptional[str] """ - 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] """ - 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. """ yaml_parameters_file_path: VariableOrOptional[str] """ - 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/hardware_accelerator_type.py b/python/databricks/bundles/jobs/_models/hardware_accelerator_type.py index 5d6ca4d1b0a..feb9f498cef 100644 --- a/python/databricks/bundles/jobs/_models/hardware_accelerator_type.py +++ b/python/databricks/bundles/jobs/_models/hardware_accelerator_type.py @@ -11,9 +11,8 @@ class HardwareAcceleratorType(Enum): GPU_1X_A10 = "GPU_1xA10" GPU_8X_H100 = "GPU_8xH100" - GPU_1X_H100 = "GPU_1xH100" HardwareAcceleratorTypeParam = ( - Literal["GPU_1xA10", "GPU_8xH100", "GPU_1xH100"] | HardwareAcceleratorType + Literal["GPU_1xA10", "GPU_8xH100"] | HardwareAcceleratorType ) 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 140e7e09ec9..1d8ee3ec1ad 100644 --- a/python/databricks/bundles/jobs/_models/model_trigger_configuration.py +++ b/python/databricks/bundles/jobs/_models/model_trigger_configuration.py @@ -25,29 +25,29 @@ class ModelTriggerConfiguration: condition: VariableOr[ModelTriggerConfigurationCondition] """ - 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) """ - 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 """ - 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. """ securable_name: VariableOrOptional[str] = None """ - 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. """ wait_after_last_change_seconds: VariableOrOptional[int] = None """ - 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. """ @@ -65,29 +65,29 @@ class ModelTriggerConfigurationDict(TypedDict, total=False): condition: VariableOr[ModelTriggerConfigurationConditionParam] """ - 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] """ - 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] """ - 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. """ securable_name: VariableOrOptional[str] """ - 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. """ wait_after_last_change_seconds: VariableOrOptional[int] """ - 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/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/task.py b/python/databricks/bundles/jobs/_models/task.py index 8cb2fe0c273..bcae59cca9a 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 Beta] 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. + [Public 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 Beta] 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. + [Public 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..00f2f64f5cf 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 + [Public 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 + [Public 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 + [Public 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 + [Public 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 7a3ec208c30..895e2802c0d 100644 --- a/python/databricks/bundles/pipelines/_models/data_staging_options.py +++ b/python/databricks/bundles/pipelines/_models/data_staging_options.py @@ -19,17 +19,17 @@ class DataStagingOptions: catalog_name: VariableOr[str] """ - (Required, Immutable) The name of the catalog for the connector's staging storage location. + [Private Preview] (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. + [Private Preview] (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. + [Private Preview] (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 : @@ -49,17 +49,17 @@ class DataStagingOptionsDict(TypedDict, total=False): catalog_name: VariableOr[str] """ - (Required, Immutable) The name of the catalog for the connector's staging storage location. + [Private Preview] (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. + [Private Preview] (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. + [Private Preview] (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 497c43acd45..07d0c483f97 100644 --- a/python/databricks/bundles/pipelines/_models/file_filter.py +++ b/python/databricks/bundles/pipelines/_models/file_filter.py @@ -17,21 +17,21 @@ class FileFilter: modified_after: VariableOrOptional[str] = None """ - 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 """ modified_before: VariableOrOptional[str] = None """ - 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 """ path_filter: VariableOrOptional[str] = None """ - 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 """ @@ -48,21 +48,21 @@ class FileFilterDict(TypedDict, total=False): modified_after: VariableOrOptional[str] """ - 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 """ modified_before: VariableOrOptional[str] """ - 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 """ path_filter: VariableOrOptional[str] """ - 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 23138c4a6e8..68d3e17d01a 100644 --- a/python/databricks/bundles/pipelines/_models/file_ingestion_options.py +++ b/python/databricks/bundles/pipelines/_models/file_ingestion_options.py @@ -29,49 +29,64 @@ class FileIngestionOptions: """ corrupt_record_column: VariableOrOptional[str] = None + """ + [Private Preview] + """ file_filters: VariableOrList[FileFilter] = field(default_factory=list) """ - Generic options + [Private Preview] Generic options """ format: VariableOrOptional[FileIngestionOptionsFileFormat] = None """ - required for TableSpec + [Private Preview] required for TableSpec """ format_options: VariableOrDict[str] = field(default_factory=dict) """ - 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 + """ + [Private Preview] + """ infer_column_types: VariableOrOptional[bool] = None + """ + [Private Preview] + """ reader_case_sensitive: VariableOrOptional[bool] = None """ - 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 + """ + [Private Preview] + """ schema_evolution_mode: VariableOrOptional[ FileIngestionOptionsSchemaEvolutionMode ] = None """ - 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 """ - 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 + """ + [Private Preview] + """ @classmethod def from_dict(cls, value: "FileIngestionOptionsDict") -> "Self": @@ -85,49 +100,64 @@ class FileIngestionOptionsDict(TypedDict, total=False): """""" corrupt_record_column: VariableOrOptional[str] + """ + [Private Preview] + """ file_filters: VariableOrList[FileFilterParam] """ - Generic options + [Private Preview] Generic options """ format: VariableOrOptional[FileIngestionOptionsFileFormatParam] """ - required for TableSpec + [Private Preview] required for TableSpec """ format_options: VariableOrDict[str] """ - 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] + """ + [Private Preview] + """ infer_column_types: VariableOrOptional[bool] + """ + [Private Preview] + """ reader_case_sensitive: VariableOrOptional[bool] """ - 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] + """ + [Private Preview] + """ schema_evolution_mode: VariableOrOptional[ FileIngestionOptionsSchemaEvolutionModeParam ] """ - 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] """ - 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] + """ + [Private Preview] + """ FileIngestionOptionsParam = FileIngestionOptionsDict | FileIngestionOptions diff --git a/python/databricks/bundles/pipelines/_models/file_ingestion_options_file_format.py b/python/databricks/bundles/pipelines/_models/file_ingestion_options_file_format.py index b9295c3378f..bf5838c8701 100644 --- a/python/databricks/bundles/pipelines/_models/file_ingestion_options_file_format.py +++ b/python/databricks/bundles/pipelines/_models/file_ingestion_options_file_format.py @@ -15,12 +15,9 @@ class FileIngestionOptionsFileFormat(Enum): PARQUET = "PARQUET" AVRO = "AVRO" ORC = "ORC" - FILE = "FILE" FileIngestionOptionsFileFormatParam = ( - Literal[ - "BINARYFILE", "JSON", "CSV", "XML", "EXCEL", "PARQUET", "AVRO", "ORC", "FILE" - ] + Literal["BINARYFILE", "JSON", "CSV", "XML", "EXCEL", "PARQUET", "AVRO", "ORC"] | FileIngestionOptionsFileFormat ) 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 f907fa9d622..d4f15e5f8a1 100644 --- a/python/databricks/bundles/pipelines/_models/google_ads_config.py +++ b/python/databricks/bundles/pipelines/_models/google_ads_config.py @@ -17,7 +17,7 @@ class GoogleAdsConfig: manager_account_id: VariableOrOptional[str] = None """ - (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), @@ -37,7 +37,7 @@ class GoogleAdsConfigDict(TypedDict, total=False): manager_account_id: VariableOrOptional[str] """ - (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 faa76baae42..f56734a849b 100644 --- a/python/databricks/bundles/pipelines/_models/google_ads_options.py +++ b/python/databricks/bundles/pipelines/_models/google_ads_options.py @@ -21,20 +21,20 @@ class GoogleAdsOptions: manager_account_id: VariableOr[str] """ - (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. """ lookback_window_days: VariableOrOptional[int] = None """ - (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. """ sync_start_date: VariableOrOptional[str] = None """ - (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. """ @@ -52,20 +52,20 @@ class GoogleAdsOptionsDict(TypedDict, total=False): manager_account_id: VariableOr[str] """ - (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. """ lookback_window_days: VariableOrOptional[int] """ - (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. """ sync_start_date: VariableOrOptional[str] """ - (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 05c7c2aaa26..e7d994c91ca 100644 --- a/python/databricks/bundles/pipelines/_models/google_drive_options.py +++ b/python/databricks/bundles/pipelines/_models/google_drive_options.py @@ -24,12 +24,18 @@ class GoogleDriveOptions: """ entity_type: VariableOrOptional[GoogleDriveOptionsGoogleDriveEntityType] = None + """ + [Private Preview] + """ file_ingestion_options: VariableOrOptional[FileIngestionOptions] = None + """ + [Private Preview] + """ url: VariableOrOptional[str] = None """ - Google Drive URL. + [Private Preview] Google Drive URL. """ @classmethod @@ -44,12 +50,18 @@ class GoogleDriveOptionsDict(TypedDict, total=False): """""" entity_type: VariableOrOptional[GoogleDriveOptionsGoogleDriveEntityTypeParam] + """ + [Private Preview] + """ file_ingestion_options: VariableOrOptional[FileIngestionOptionsParam] + """ + [Private Preview] + """ url: VariableOrOptional[str] """ - Google Drive URL. + [Private Preview] Google Drive URL. """ diff --git a/python/databricks/bundles/pipelines/_models/google_drive_options_google_drive_entity_type.py b/python/databricks/bundles/pipelines/_models/google_drive_options_google_drive_entity_type.py index 4ddab6c6792..136b3aff953 100644 --- a/python/databricks/bundles/pipelines/_models/google_drive_options_google_drive_entity_type.py +++ b/python/databricks/bundles/pipelines/_models/google_drive_options_google_drive_entity_type.py @@ -10,13 +10,9 @@ class GoogleDriveOptionsGoogleDriveEntityType(Enum): FILE = "FILE" FILE_METADATA = "FILE_METADATA" PERMISSION = "PERMISSION" - FILE_PERMISSION = "FILE_PERMISSION" - GROUP_MEMBERSHIP = "GROUP_MEMBERSHIP" GoogleDriveOptionsGoogleDriveEntityTypeParam = ( - Literal[ - "FILE", "FILE_METADATA", "PERMISSION", "FILE_PERMISSION", "GROUP_MEMBERSHIP" - ] + Literal["FILE", "FILE_METADATA", "PERMISSION"] | GoogleDriveOptionsGoogleDriveEntityType ) diff --git a/python/databricks/bundles/pipelines/_models/ingestion_config.py b/python/databricks/bundles/pipelines/_models/ingestion_config.py index 988227c43e3..4ccd935e819 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_config.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_config.py @@ -21,17 +21,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 @@ -47,17 +47,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 abe37602e5b..bf82c500273 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_gateway_pipeline_definition.py @@ -21,34 +21,34 @@ class IngestionGatewayPipelineDefinition: connection_name: VariableOr[str] """ - 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] """ - 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] """ - 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_id: VariableOrOptional[str] = None """ - [DEPRECATED] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + [DEPRECATED] [Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. """ 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 """ - 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. """ @@ -66,34 +66,34 @@ class IngestionGatewayPipelineDefinitionDict(TypedDict, total=False): connection_name: VariableOr[str] """ - 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] """ - 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] """ - 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_id: VariableOrOptional[str] """ - [DEPRECATED] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. + [DEPRECATED] [Private Preview] [Deprecated, use connection_name instead] Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source. """ 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] """ - 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 b36632a55cf..0a9716aefb0 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 @@ -53,14 +53,14 @@ class IngestionPipelineDefinition: """ :meta private: [EXPERIMENTAL] - (Optional) Connector Type for sources. Ex: CDC, Query Based. + [Private Preview] (Optional) Connector Type for sources. Ex: CDC, Query Based. """ data_staging_options: VariableOrOptional[DataStagingOptions] = None """ :meta private: [EXPERIMENTAL] - (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline + [Private Preview] (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. @@ -68,12 +68,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. @@ -81,7 +81,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. @@ -90,21 +90,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 @@ -120,7 +122,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 @@ -134,14 +136,14 @@ class IngestionPipelineDefinitionDict(TypedDict, total=False): """ :meta private: [EXPERIMENTAL] - (Optional) Connector Type for sources. Ex: CDC, Query Based. + [Private Preview] (Optional) Connector Type for sources. Ex: CDC, Query Based. """ data_staging_options: VariableOrOptional[DataStagingOptionsParam] """ :meta private: [EXPERIMENTAL] - (Optional) Location of staged data storage. This is required for migration from Cdc Managed Ingestion Pipeline + [Private Preview] (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. @@ -149,12 +151,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. @@ -162,7 +164,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. @@ -171,21 +173,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..d758617b01a 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 + [Public 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 + [Public 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 d48d68495df..4815308900a 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 @@ -25,14 +25,14 @@ class IngestionPipelineDefinitionWorkdayReportParameters: incremental: VariableOrOptional[bool] = None """ - [DEPRECATED] (Optional) Marks the report as incremental. + [DEPRECATED] [Private Preview] (Optional) Marks the report as incremental. This field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now controlled by the `parameters` field. """ parameters: VariableOrDict[str] = field(default_factory=dict) """ - 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 IngestionPipelineDefinitionWorkdayReportParameters: IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue ] = field(default_factory=list) """ - [DEPRECATED] (Optional) Additional custom parameters for Workday Report + [DEPRECATED] [Private Preview] (Optional) Additional custom parameters for Workday Report This field is deprecated and should not be used. Use `parameters` instead. """ @@ -64,14 +64,14 @@ class IngestionPipelineDefinitionWorkdayReportParametersDict(TypedDict, total=Fa incremental: VariableOrOptional[bool] """ - [DEPRECATED] (Optional) Marks the report as incremental. + [DEPRECATED] [Private Preview] (Optional) Marks the report as incremental. This field is deprecated and should not be used. Use `parameters` instead. The incremental behavior is now controlled by the `parameters` field. """ parameters: VariableOrDict[str] """ - 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: { @@ -84,7 +84,7 @@ class IngestionPipelineDefinitionWorkdayReportParametersDict(TypedDict, total=Fa IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueParam ] """ - [DEPRECATED] (Optional) Additional custom parameters for Workday Report + [DEPRECATED] [Private Preview] (Optional) Additional custom parameters for Workday Report This field is deprecated and should not be used. Use `parameters` instead. """ diff --git a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters_query_key_value.py b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters_query_key_value.py index 2a24858d66e..05a7d794939 100644 --- a/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters_query_key_value.py +++ b/python/databricks/bundles/pipelines/_models/ingestion_pipeline_definition_workday_report_parameters_query_key_value.py @@ -19,12 +19,12 @@ class IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue: key: VariableOrOptional[str] = None """ - Key for the report parameter, can be a column name or other metadata + [Private Preview] Key for the report parameter, can be a column name or other metadata """ value: VariableOrOptional[str] = None """ - Value for the report parameter. + [Private Preview] Value for the report parameter. Possible values it can take are these sql functions: 1. coalesce(current_offset(), date("YYYY-MM-DD")) -> if current_offset() is null, then the passed date, else current_offset() 2. current_date() @@ -51,12 +51,12 @@ class IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValueDict( key: VariableOrOptional[str] """ - Key for the report parameter, can be a column name or other metadata + [Private Preview] Key for the report parameter, can be a column name or other metadata """ value: VariableOrOptional[str] """ - Value for the report parameter. + [Private Preview] Value for the report parameter. Possible values it can take are these sql functions: 1. coalesce(current_offset(), date("YYYY-MM-DD")) -> if current_offset() is null, then the passed date, else current_offset() 2. current_date() diff --git a/python/databricks/bundles/pipelines/_models/jira_connector_options.py b/python/databricks/bundles/pipelines/_models/jira_connector_options.py index b0d1e82582f..178f1f64472 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 + [Public 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 + [Public Beta] (Optional) Projects to filter Jira data on """ diff --git a/python/databricks/bundles/pipelines/_models/kafka_options.py b/python/databricks/bundles/pipelines/_models/kafka_options.py index 0b83708ee3a..b37e72ed2ee 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. """ @@ -42,7 +42,7 @@ 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 @@ -84,7 +84,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. """ @@ -99,7 +99,7 @@ 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] diff --git a/python/databricks/bundles/pipelines/_models/meta_marketing_options.py b/python/databricks/bundles/pipelines/_models/meta_marketing_options.py index fb9d5b8f8ba..9089bd45aa1 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") + [Public 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 + [Public 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) + [Public 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 + [Public 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 + [Public 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) + [Public 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 + [Public 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) + [Public 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") + [Public 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 + [Public 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) + [Public Beta] (Optional) Timing used to report action statistics (impression, conversion, mixed, or lifetime) """ breakdowns: VariableOrList[str] """ - (Optional) Breakdowns to configure for data aggregation + [Public 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 + [Public 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) + [Public 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 + [Public 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) + [Public 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 62138c598f8..91ec88bb1a1 100644 --- a/python/databricks/bundles/pipelines/_models/outlook_options.py +++ b/python/databricks/bundles/pipelines/_models/outlook_options.py @@ -27,25 +27,25 @@ class OutlookOptions: attachment_mode: VariableOrOptional[OutlookAttachmentMode] = None """ - (Optional) Controls which attachments to ingest. + [Private Preview] (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. """ body_format: VariableOrOptional[OutlookBodyFormat] = None """ - (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. """ folder_filter: VariableOrList[str] = field(default_factory=list) """ - [DEPRECATED] Deprecated. Use include_folders instead. + [DEPRECATED] [Private Preview] Deprecated. Use include_folders instead. """ include_folders: VariableOrList[str] = field(default_factory=list) """ - (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. @@ -53,14 +53,14 @@ class OutlookOptions: include_mailboxes: VariableOrList[str] = field(default_factory=list) """ - (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. """ include_senders: VariableOrList[str] = field(default_factory=list) """ - (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. @@ -68,7 +68,7 @@ class OutlookOptions: include_subjects: VariableOrList[str] = field(default_factory=list) """ - (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. @@ -77,12 +77,12 @@ class OutlookOptions: sender_filter: VariableOrList[str] = field(default_factory=list) """ - [DEPRECATED] Deprecated. Use include_senders instead. + [DEPRECATED] [Private Preview] Deprecated. Use include_senders instead. """ start_date: VariableOrOptional[str] = None """ - (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. @@ -90,7 +90,7 @@ class OutlookOptions: subject_filter: VariableOrList[str] = field(default_factory=list) """ - [DEPRECATED] Deprecated. Use include_subjects instead. + [DEPRECATED] [Private Preview] Deprecated. Use include_subjects instead. """ @classmethod @@ -106,25 +106,25 @@ class OutlookOptionsDict(TypedDict, total=False): attachment_mode: VariableOrOptional[OutlookAttachmentModeParam] """ - (Optional) Controls which attachments to ingest. + [Private Preview] (Optional) Controls which attachments to ingest. If not specified, defaults to ALL. """ body_format: VariableOrOptional[OutlookBodyFormatParam] """ - (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. """ folder_filter: VariableOrList[str] """ - [DEPRECATED] Deprecated. Use include_folders instead. + [DEPRECATED] [Private Preview] Deprecated. Use include_folders instead. """ include_folders: VariableOrList[str] """ - (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. @@ -132,14 +132,14 @@ class OutlookOptionsDict(TypedDict, total=False): include_mailboxes: VariableOrList[str] """ - (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. """ include_senders: VariableOrList[str] """ - (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. @@ -147,7 +147,7 @@ class OutlookOptionsDict(TypedDict, total=False): include_subjects: VariableOrList[str] """ - (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. @@ -156,12 +156,12 @@ class OutlookOptionsDict(TypedDict, total=False): sender_filter: VariableOrList[str] """ - [DEPRECATED] Deprecated. Use include_senders instead. + [DEPRECATED] [Private Preview] Deprecated. Use include_senders instead. """ start_date: VariableOrOptional[str] """ - (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. @@ -169,7 +169,7 @@ class OutlookOptionsDict(TypedDict, total=False): subject_filter: VariableOrList[str] """ - [DEPRECATED] Deprecated. Use include_subjects instead. + [DEPRECATED] [Private Preview] Deprecated. Use include_subjects instead. """ 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..8e50464817a 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) @@ -170,12 +170,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 +213,7 @@ class Pipeline(Resource): """ :meta private: [EXPERIMENTAL] - Usage policy of this pipeline. + [Private Preview] Usage policy of this pipeline. """ @classmethod @@ -234,7 +234,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 +274,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 +291,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 +301,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] @@ -337,12 +337,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 +380,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 2385a32c7ab..a34cf9a3754 100644 --- a/python/databricks/bundles/pipelines/_models/restart_window.py +++ b/python/databricks/bundles/pipelines/_models/restart_window.py @@ -22,19 +22,19 @@ class RestartWindow: start_hour: VariableOr[int] """ - 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. """ days_of_week: VariableOrList[DayOfWeek] = field(default_factory=list) """ - 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. """ time_zone_id: VariableOrOptional[str] = None """ - 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. """ @@ -51,19 +51,19 @@ class RestartWindowDict(TypedDict, total=False): start_hour: VariableOr[int] """ - 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. """ days_of_week: VariableOrList[DayOfWeekParam] """ - 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. """ time_zone_id: VariableOrOptional[str] """ - 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 72fe41e11e1..197b9221b74 100644 --- a/python/databricks/bundles/pipelines/_models/sharepoint_options.py +++ b/python/databricks/bundles/pipelines/_models/sharepoint_options.py @@ -25,18 +25,18 @@ class SharepointOptions: entity_type: VariableOrOptional[SharepointOptionsSharepointEntityType] = None """ - (Optional) The type of SharePoint entity to ingest. + [Private Preview] (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. """ file_ingestion_options: VariableOrOptional[FileIngestionOptions] = None """ - (Optional) File ingestion options for processing files. + [Private Preview] (Optional) File ingestion options for processing files. """ url: VariableOrOptional[str] = None """ - Required. The SharePoint URL. + [Private Preview] Required. The SharePoint URL. """ @classmethod @@ -52,18 +52,18 @@ class SharepointOptionsDict(TypedDict, total=False): entity_type: VariableOrOptional[SharepointOptionsSharepointEntityTypeParam] """ - (Optional) The type of SharePoint entity to ingest. + [Private Preview] (Optional) The type of SharePoint entity to ingest. If not specified, defaults to FILE. """ file_ingestion_options: VariableOrOptional[FileIngestionOptionsParam] """ - (Optional) File ingestion options for processing files. + [Private Preview] (Optional) File ingestion options for processing files. """ url: VariableOrOptional[str] """ - Required. The SharePoint URL. + [Private Preview] Required. The SharePoint URL. """ diff --git a/python/databricks/bundles/pipelines/_models/sharepoint_options_sharepoint_entity_type.py b/python/databricks/bundles/pipelines/_models/sharepoint_options_sharepoint_entity_type.py index 21f76eca27f..46e15fff79d 100644 --- a/python/databricks/bundles/pipelines/_models/sharepoint_options_sharepoint_entity_type.py +++ b/python/databricks/bundles/pipelines/_models/sharepoint_options_sharepoint_entity_type.py @@ -11,18 +11,9 @@ class SharepointOptionsSharepointEntityType(Enum): FILE_METADATA = "FILE_METADATA" PERMISSION = "PERMISSION" LIST = "LIST" - FILE_PERMISSION = "FILE_PERMISSION" - GROUP_MEMBERSHIP = "GROUP_MEMBERSHIP" SharepointOptionsSharepointEntityTypeParam = ( - Literal[ - "FILE", - "FILE_METADATA", - "PERMISSION", - "LIST", - "FILE_PERMISSION", - "GROUP_MEMBERSHIP", - ] + Literal["FILE", "FILE_METADATA", "PERMISSION", "LIST"] | SharepointOptionsSharepointEntityType ) diff --git a/python/databricks/bundles/pipelines/_models/smartsheet_options.py b/python/databricks/bundles/pipelines/_models/smartsheet_options.py index 4f4426b74ed..af79177ebc1 100644 --- a/python/databricks/bundles/pipelines/_models/smartsheet_options.py +++ b/python/databricks/bundles/pipelines/_models/smartsheet_options.py @@ -19,7 +19,7 @@ class SmartsheetOptions: enforce_schema: VariableOrOptional[bool] = None """ - (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. @@ -39,7 +39,7 @@ class SmartsheetOptionsDict(TypedDict, total=False): enforce_schema: VariableOrOptional[bool] """ - (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 8c304eb5614..7dba4f8c0a7 100644 --- a/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py +++ b/python/databricks/bundles/pipelines/_models/tik_tok_ads_options.py @@ -27,47 +27,47 @@ class TikTokAdsOptions: data_level: VariableOrOptional[TikTokAdsOptionsTikTokDataLevel] = None """ - (Optional) Data level for the report. + [Private Preview] (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. """ dimensions: VariableOrList[str] = field(default_factory=list) """ - (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. """ lookback_window_days: VariableOrOptional[int] = None """ - (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. """ metrics: VariableOrList[str] = field(default_factory=list) """ - (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.) """ query_lifetime: VariableOrOptional[bool] = None """ - (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. """ report_type: VariableOrOptional[TikTokAdsOptionsTikTokReportType] = None """ - (Optional) Report type for the TikTok Ads API. + [Private Preview] (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. """ sync_start_date: VariableOrOptional[str] = None """ - (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. @@ -86,47 +86,47 @@ class TikTokAdsOptionsDict(TypedDict, total=False): data_level: VariableOrOptional[TikTokAdsOptionsTikTokDataLevelParam] """ - (Optional) Data level for the report. + [Private Preview] (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN. """ dimensions: VariableOrList[str] """ - (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. """ lookback_window_days: VariableOrOptional[int] """ - (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. """ metrics: VariableOrList[str] """ - (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.) """ query_lifetime: VariableOrOptional[bool] """ - (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. """ report_type: VariableOrOptional[TikTokAdsOptionsTikTokReportTypeParam] """ - (Optional) Report type for the TikTok Ads API. + [Private Preview] (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC. """ sync_start_date: VariableOrOptional[str] """ - (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_format.py b/python/databricks/bundles/pipelines/_models/transformer_format.py index b37db5110ce..5682c94d794 100644 --- a/python/databricks/bundles/pipelines/_models/transformer_format.py +++ b/python/databricks/bundles/pipelines/_models/transformer_format.py @@ -9,10 +9,6 @@ class TransformerFormat(Enum): STRING = "STRING" JSON = "JSON" - AVRO = "AVRO" - PROTOBUF = "PROTOBUF" -TransformerFormatParam = ( - Literal["STRING", "JSON", "AVRO", "PROTOBUF"] | TransformerFormat -) +TransformerFormatParam = Literal["STRING", "JSON"] | TransformerFormat diff --git a/python/databricks/bundles/pipelines/_models/zendesk_support_options.py b/python/databricks/bundles/pipelines/_models/zendesk_support_options.py index a64ecf73f2f..3210059ce16 100644 --- a/python/databricks/bundles/pipelines/_models/zendesk_support_options.py +++ b/python/databricks/bundles/pipelines/_models/zendesk_support_options.py @@ -19,7 +19,7 @@ class ZendeskSupportOptions: start_date: VariableOrOptional[str] = None """ - (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. """ @@ -36,7 +36,7 @@ class ZendeskSupportOptionsDict(TypedDict, total=False): start_date: VariableOrOptional[str] """ - (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. """ diff --git a/python/databricks/bundles/schemas/_models/privilege.py b/python/databricks/bundles/schemas/_models/privilege.py index 74f25b462c1..20f4e1f5573 100644 --- a/python/databricks/bundles/schemas/_models/privilege.py +++ b/python/databricks/bundles/schemas/_models/privilege.py @@ -53,20 +53,6 @@ class Privilege(Enum): MODIFY_CLEAN_ROOM = "MODIFY_CLEAN_ROOM" EXECUTE_CLEAN_ROOM_TASK = "EXECUTE_CLEAN_ROOM_TASK" EXTERNAL_USE_SCHEMA = "EXTERNAL_USE_SCHEMA" - VIEW_OBJECT = "VIEW_OBJECT" - MANAGE_GRANTS = "MANAGE_GRANTS" - INSERT = "INSERT" - UPDATE = "UPDATE" - DELETE = "DELETE" - VIEW_ADMIN_METADATA = "VIEW_ADMIN_METADATA" - VIEW_METADATA = "VIEW_METADATA" - USE_VOLUME = "USE_VOLUME" - READ_METADATA = "READ_METADATA" - MANAGE_ACCESS = "MANAGE_ACCESS" - MANAGE_ACCESS_CONTROL = "MANAGE_ACCESS_CONTROL" - CREATE_SERVICE = "CREATE_SERVICE" - CREATE_FEATURE = "CREATE_FEATURE" - READ_FEATURE = "READ_FEATURE" PrivilegeParam = ( @@ -121,20 +107,6 @@ class Privilege(Enum): "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", "EXTERNAL_USE_SCHEMA", - "VIEW_OBJECT", - "MANAGE_GRANTS", - "INSERT", - "UPDATE", - "DELETE", - "VIEW_ADMIN_METADATA", - "VIEW_METADATA", - "USE_VOLUME", - "READ_METADATA", - "MANAGE_ACCESS", - "MANAGE_ACCESS_CONTROL", - "CREATE_SERVICE", - "CREATE_FEATURE", - "READ_FEATURE", ] | Privilege ) diff --git a/python/databricks/bundles/volumes/_models/privilege.py b/python/databricks/bundles/volumes/_models/privilege.py index 74f25b462c1..20f4e1f5573 100644 --- a/python/databricks/bundles/volumes/_models/privilege.py +++ b/python/databricks/bundles/volumes/_models/privilege.py @@ -53,20 +53,6 @@ class Privilege(Enum): MODIFY_CLEAN_ROOM = "MODIFY_CLEAN_ROOM" EXECUTE_CLEAN_ROOM_TASK = "EXECUTE_CLEAN_ROOM_TASK" EXTERNAL_USE_SCHEMA = "EXTERNAL_USE_SCHEMA" - VIEW_OBJECT = "VIEW_OBJECT" - MANAGE_GRANTS = "MANAGE_GRANTS" - INSERT = "INSERT" - UPDATE = "UPDATE" - DELETE = "DELETE" - VIEW_ADMIN_METADATA = "VIEW_ADMIN_METADATA" - VIEW_METADATA = "VIEW_METADATA" - USE_VOLUME = "USE_VOLUME" - READ_METADATA = "READ_METADATA" - MANAGE_ACCESS = "MANAGE_ACCESS" - MANAGE_ACCESS_CONTROL = "MANAGE_ACCESS_CONTROL" - CREATE_SERVICE = "CREATE_SERVICE" - CREATE_FEATURE = "CREATE_FEATURE" - READ_FEATURE = "READ_FEATURE" PrivilegeParam = ( @@ -121,20 +107,6 @@ class Privilege(Enum): "MODIFY_CLEAN_ROOM", "EXECUTE_CLEAN_ROOM_TASK", "EXTERNAL_USE_SCHEMA", - "VIEW_OBJECT", - "MANAGE_GRANTS", - "INSERT", - "UPDATE", - "DELETE", - "VIEW_ADMIN_METADATA", - "VIEW_METADATA", - "USE_VOLUME", - "READ_METADATA", - "MANAGE_ACCESS", - "MANAGE_ACCESS_CONTROL", - "CREATE_SERVICE", - "CREATE_FEATURE", - "READ_FEATURE", ] | Privilege )